Creators

Get a creator

GET/v1/creators/{creator_id}

Returns a single creator by Fansquare id. Returns 404 if the creator does not exist or is outside the scope of the API key.

Required scoperead:creators

Rate limit60 requests per minute

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

{
  "id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "account": {
    "status": "active",
    "username": "lena.official",
    "external_id": "c851d9d6-b90b-4958-aed2-2fdaa2fe21a3"
  }
}

Parameters

Headers

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

Path

creator_idstringrequired
Fansquare creator id (internal).
min length 1

Response

OK, application/json

idstringrequired
Fansquare creator id.
namestringrequired
Display name in the Fansquare CRM.
accountobject | nullrequired
The MYM account of the creator, or null while she has none.
statusstringrequired
Connection state of the MYM account: active when Fansquare reads it, pending while it is being connected, invalid or revoked when its access no longer works.
Valuesactivependinginvalidrevoked
usernamestring | nullrequired
MYM username of the creator, when known.
external_idstring | nullrequired
MYM account id. Used as account_id on the /v1/accounts routes.

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

{
  "id": "m81IhLxdhzDGYs54rNp2",
  "name": "Lena",
  "account": {
    "status": "active",
    "username": "lena.official",
    "external_id": "c851d9d6-b90b-4958-aed2-2fdaa2fe21a3"
  }
}