Substy Developers
Scripts

List agency subscriptions

List the agency's Substy subscriptions across its creator accounts.

GET/v1/agencies/{agencyId}/subscriptions

List the agency's Substy subscriptions across its creator accounts.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length

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/subscriptions" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": [    {      "creator": {        "description": null,        "agencyId": "string",        "label": null,        "platform": "ONLYFANS",        "id": "string",        "createdAt": "2019-08-24T14:15:22Z",        "name": "string",        "age": null,        "birthday": null,        "timezone": null,        "platformUserId": null,        "url": null,        "pseudo": null,        "pending": true,        "needA2fVerification": true,        "verifiedAt": null,        "gender": "MALE",        "living": "string",        "updatedAt": "2019-08-24T14:15:22Z",        "profession": null,        "weight": null,        "shoeSize": null,        "braCupSize": null,        "ethnicity": null,        "appearance": null,        "hairColor": null,        "eyeColor": null,        "primaryLanguage": null,        "otherLanguages": [          "string"        ],        "languages": null,        "trackingLinkSyncListId": null,        "isDeleted": true,        "deletedAt": null,        "chatInboxEnabled": true,        "isNearby": true      },      "creatorId": "string",      "id": "string",      "createdAt": "2019-08-24T14:15:22Z",      "status": "ACTIVE",      "updatedAt": "2019-08-24T14:15:22Z",      "startDate": "2019-08-24T14:15:22Z",      "endDate": null,      "rate": null,      "planId": "string",      "billingCycle": "DAILY",      "walletId": null,      "subscriptionPrice": "string",      "nextBillingDate": null,      "lastBillingDate": null,      "consecutiveFailures": 0,      "maxAllowedFailures": 0,      "suspendedAt": null,      "isTrial": true    }  ],  "meta": {    "requestId": "string"  }}

Update script message pacing PATCH

Set the minimum and maximum conversation exchanges before this script step, from 0 to 10. These values count exchanges, not elapsed minutes; null removes the corresponding override.

Get creator platform media GET

Read one media item directly from the creator's connected platform. Use vault tools for Substy vault metadata and media-download tools for file bytes.