Substy Developers
Inbox and fans

List creator conversations

List a creator's fan conversations, optionally filtering AI status, unread conversations, human handoffs or inbox. AI status defaults to all conversations. Continue with the returned opaque cursor when more results are available.

GET/v1/agencies/{agencyId}/creators/{creatorId}/conversations

List a creator's fan conversations, optionally filtering AI status, unread conversations, human handoffs or inbox. AI status defaults to all conversations. Continue with the returned opaque cursor when more results are available.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string

Creator ID returned by list_accessible_creators.

Length1 <= length

Query Parameters

query?string

Search the creator inbox; omit to browse conversations.

Lengthlength <= 300
Default""
limit?integer
Range1 <= value <= 100
Default20
cursor?string

Copy nextCursor from the previous page and keep the same filters and limit.

Length1 <= length <= 16384
unreadOnly?boolean
Defaultfalse
aiStatus?string
Default"all"

Value in

  • "all"
  • "enabled"
  • "disabled"
handoffOnly?boolean
Defaultfalse
order?string

Provider conversation order: recent first or oldest first.

Default"recent"

Value in

  • "recent"
  • "old"
listId?|
Defaultnull
inboxIds?array<>
Itemsitems <= 100
Default[]
languages?array<string>
Itemsitems <= 100
Default[]
platformFilters?array<string>
Itemsitems <= 100
Default[]
platformSortBy?string

Optional provider-specific sort; omit for normal conversation order.

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/conversations" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "chats": [      {        "id": "string",        "user": {          "displayName": null,          "isCreator": true,          "isBlocked": true,          "isRestricted": true,          "aiEnabled": true,          "needsHandoff": null,          "lists": [            {              "id": "string",              "name": "string",              "type": "string",              "usersCount": null,              "users": null,              "canPinToChat": null,              "isPinnedToChat": null            }          ],          "chatInboxId": null,          "id": "string",          "name": "string",          "username": "string",          "avatar": null        },        "lastMessage": {          "id": "string",          "text": "string",          "createdAt": "string",          "isFromMe": null,          "mediaCount": null,          "mediaType": null,          "giphyId": null        },        "sidebar": null,        "canSendMessage": true,        "unreadCount": 0,        "isMuted": true      }    ],    "hasMore": null,    "nextCursor": "string",    "previousCursor": null  },  "meta": {    "requestId": "string"  }}

Create creator fan list POST

Create a named platform fan list for the creator. Add fans separately using add_fan_to_lists.

Pin creator fan list PATCH

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