Substy Developers
Inbox and fans

Get fan profile

Read a fan's profile and relationship with one creator, including available spending and subscription details. Fan identity is scoped to the supplied creator.

GET/v1/agencies/{agencyId}/creators/{creatorId}/fans/{fanId}

Read a fan's profile and relationship with one creator, including available spending and subscription details. Fan identity is scoped to the supplied creator.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string
fanId*string

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/fans/string" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "enabled": null,    "creatorId": null,    "name": "string",    "age": null,    "birthday": null,    "job": null,    "hobbies": null,    "interests": null,    "fan_place": null,    "nickname": null,    "isFemale": null,    "family_information": null,    "friends_information": null,    "origins": null,    "likes": null,    "dislikes": null,    "dick_size": null,    "dreams": null,    "payday": null,    "salary": null,    "notes": "string",    "language": null,    "timezone": null,    "aiDisabledAt": null,    "aiDisabledByEmployeeId": null,    "handoffRequestedAt": null,    "handoffResolvedAt": null,    "handoffResolvedByEmployeeId": null,    "lastSentMessageAt": null,    "lastFanReplyAt": null,    "chatInboxId": null,    "chatId": null,    "id": "string",    "username": "string",    "displayName": null,    "avatar": null,    "avatarThumbnails": null,    "isCreator": true,    "isRestricted": true,    "subscribePrice": 0,    "isSubscribed": true,    "subscribedFor": "string",    "lists": [      {        "hasUser": true,        "canAddUser": true,        "id": "string",        "name": "string",        "type": "string"      }    ],    "lastSeen": null,    "canChat": true,    "spentDetails": {      "ai": 0,      "tips": 0,      "subscribes": 0,      "messages": 0,      "posts": 0,      "streams": 0    },    "totalSpent": 0,    "isBlocked": true,    "isMuted": true,    "aiEnabled": true,    "subscribedAt": null,    "lastPpvPurchaseAt": null,    "isCanceledNextMonth": true  },  "meta": {    "requestId": "string"  }}

List fan messages GET

Read messages between one creator and fan, with pagination and ordering filters. Follow the returned next or previous cursor to retrieve more of the conversation.

Update fan profile PATCH

Update the supplied editable relationship fields for a fan and creator, such as notes or AI controls. Omitted fields retain their current values.