Substy Developers
Inbox and fans

List creator chat fans

List fans available to a creator's chat view, optionally restricted to a platform list. Continue using the returned next cursor.

GET/v1/agencies/{agencyId}/creators/{creatorId}/conversation-users

List fans available to a creator's chat view, optionally restricted to a platform list. Continue using the returned next cursor.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string

Query Parameters

limit?never
listId?|
Defaultnull
sort?string
Default"desc"

Value in

  • "asc"
  • "desc"
cursor?number
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/creators/string/conversation-users" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "users": [      {        "id": null,        "name": null,        "displayName": null,        "username": null,        "avatar": null,        "needsHandoff": null      }    ],    "hasMore": true  },  "meta": {    "requestId": "string"  }}

Pin creator fan list PATCH

Pin or unpin the selected platform fan list for the creator using the supplied pinned state.

Get creator unread count GET

Read the creator's current unread-message or unread-conversation counts returned by the platform.