Fans

Get a fan

GET/v1/accounts/{account_id}/fans/{fan_id}

Returns the CRM state Fansquare holds for this fan on this account. Returns 404 if the account has no relation with this fan.

Required scoperead:fans

Rate limit60 requests per minute

curl 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/fans/a6df8022-e509-4575-ad28-e29c2d1d42dc' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "fan_id": "a6df8022-e509-4575-ad28-e29c2d1d42dc",
  "fan_username": "alex_92",
  "assigned_user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
  "ai_active": true,
  "tags": [
    {
      "id": "58368a92-838b-4cb0-ab37-d54ce826ea11",
      "name": "VIP"
    }
  ]
}

Parameters

Headers

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

Path

account_idstringrequired
MYM account id (account.external_id in GET /v1/creators).
min length 1
fan_idstringrequired
MYM fan id.
format uuid

Response

OK, application/json

fan_idstringrequired
MYM fan id.
fan_usernamestring | nullrequired
MYM username of the fan, when available.
assigned_user_idstring | nullrequired
Fansquare id of the assigned employee, or null. Resolve names with GET /v1/employees.
ai_activebooleanrequired
true while an AI currently holds the lock on this fan.
tagsarray of objectsrequired
Tags set on this fan in Fansquare. Empty when the fan has no tag. Full catalog with colors: GET /v1/tags.
idstringrequired
Fansquare tag id, from GET /v1/tags.
namestringrequired
Tag label, as shown on the fan card in Fansquare.

curl 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/fans/a6df8022-e509-4575-ad28-e29c2d1d42dc' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "fan_id": "a6df8022-e509-4575-ad28-e29c2d1d42dc",
  "fan_username": "alex_92",
  "assigned_user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
  "ai_active": true,
  "tags": [
    {
      "id": "58368a92-838b-4cb0-ab37-d54ce826ea11",
      "name": "VIP"
    }
  ]
}