Insights

Get the insight note of a fan

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

Returns the free-text CRM note Fansquare holds for this fan on this account, plus its concurrency token. The token comes back twice, in the etag body field and in the ETag response header: they carry the same value, pick whichever your client reads more easily. Send it back when you PATCH so an edit never overwrites a note that changed since you read it. Returns 404 if the account has no relation with this fan.

Required scoperead:insights

Rate limit30 requests per minute

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

{
  "note": "Prefers short replies. Birthday on March 3.",
  "etag": "3f2a9c1e"
}

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

Headers

ETagstring
Concurrency token, quoted per HTTP. Identical to the etag body field, which is easier to consume in most clients. Use whichever you prefer.

notestring | nullrequired
Free-text CRM note on this creator×fan relation, or null when none is set. Plain text, stored as sent. Use \n for a line break and \n\n for a blank line between paragraphs. Each escape counts as one character against the 2000 limit.
etagstringrequired
Concurrency token for this note. Send it back on the next PATCH (as the etag body field, or as an If-Match header) so an edit never overwrites a change you have not seen. Also returned as the ETag response header, unquoted here.

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

{
  "note": "Prefers short replies. Birthday on March 3.",
  "etag": "3f2a9c1e"
}