Fans

List the fan tags of the agency

GET/v1/tags

Lists the tags the agency uses to segment its fans, in the order shown in Fansquare. Tags are agency-level: the creator scope of the key does not apply. Use the ids to read tags on fans and to filter GET /v1/accounts/{account_id}/fans with tag_ids.

Required scoperead:fans

Rate limit60 requests per minute

curl 'https://api.fansquare.so/v1/tags' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "id": "58368a92-838b-4cb0-ab37-d54ce826ea11",
      "name": "VIP",
      "color": "#FFD900"
    }
  ]
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Response

OK, application/json

dataarray of objectsrequired
idstringrequired
Fansquare tag id, referenced by tags[].id on fans and by the tag_ids filter.
namestringrequired
Tag label, as shown on the fan card in Fansquare.
colorstring | nullrequired
Tag color configured in Fansquare (CSS color string), or null.

curl 'https://api.fansquare.so/v1/tags' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "id": "58368a92-838b-4cb0-ab37-d54ce826ea11",
      "name": "VIP",
      "color": "#FFD900"
    }
  ]
}