Fanvue API Documentation

curl https://api.fanvue.com/agencies/chats \
     -H "X-Fanvue-API-Version: 2025-06-26" \
     -H "Authorization: Bearer <token>"

{
  "data": [
    {
      "createdAt": "2024-01-15T00:00:00.000Z",
      "lastMessageAt": "2024-01-15T00:00:00.000Z",
      "isRead": false,
      "isMuted": false,
      "unreadMessagesCount": 3,
      "user": {
        "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "handle": "sarah-jones",
        "displayName": "Sarah Jones",
        "nickname": "SarahK",
        "isTopSpender": true,
        "avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
        "registeredAt": "2024-01-10T12:00:00.000Z"
      },
      "lastMessage": {
        "text": "Hey there! How are you doing?",
        "type": "SINGLE_RECIPIENT",
        "uuid": "a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6",
        "sentAt": "2024-01-15T00:00:00.000Z",
        "hasMedia": true,
        "mediaType": "image",
        "senderUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8",
        "sentByUserId": null
      },
      "creatorUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r8"
    },
    {
      "createdAt": "2024-01-14T00:00:00.000Z",
      "lastMessageAt": "2024-01-15T00:00:00.000Z",
      "isRead": true,
      "isMuted": false,
      "unreadMessagesCount": 0,
      "user": {
        "uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "handle": "mike-smith",
        "displayName": "Mike Smithly",
        "nickname": null,
        "isTopSpender": false,
        "avatarUrl": "https://media.fanvue.com/avatars/example-avatar.jpg",
        "registeredAt": "2024-01-10T12:00:00.000Z"
      },
      "lastMessage": null,
      "creatorUuid": "c3d4e5f6-7g8h-9i0j-1k2l-m3n4o5p6q7r9"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 2,
    "hasMore": true
  }
}

Returns a single paginated stream of chats across every creator the authenticated agency manages, sorted by most recent activity. Each row is tagged with creatorUuid so consumers can group results by creator without an additional join.

Replaces the per-creator GET /creators/{uuid}/chats fan-out used by agency CRM sync flows: 1 + N calls collapse to ceil(total/size) calls.

Mute state is per-creator: isMuted is true only when the specific creator that owns the chat row has muted the counterpart, not when any other agency creator has.

Scopes required: read:agency, read:chat

Requires: Agency admin access

Returns a single paginated stream of chats across every creator the authenticated agency manages, sorted by most recent activity. Each row is tagged with `creatorUuid` so consumers can group results by creator without an additional join. Replaces the per-creator `GET /creators/{uuid}/chats` fan-out used by agency CRM sync flows: 1 + N calls collapse to ceil(total/size) calls. Mute state is per-creator: `isMuted` is true only when the specific creator that owns the chat row has muted the counterpart, not when any other agency creator has. <Info>Scopes required: `read:agency`, `read:chat`</Info> <Info>Requires: Agency admin access</Info>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pagedoubleOptional>=1Defaults to 1

Page number to retrieve (starts from 1)

sizedoubleOptional1-50Defaults to 15

Number of items to return per page (1-50, default: 15)

Response

Paginated list of chats across the agency's creators

datalist of objects

Array of chats across the agency's creators

paginationobject

Pagination information

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

410

Gone Error

429

Too Many Requests Error

List chats across all agency creators

Authentication

Headers

Query parameters

Response

Errors