Sign in
Free Trial Links

List Free Trial Link Subscribers

Get list of subscribers who joined through a Free Trial Link

get/api/{account}/trial-links/{trial_link_id}/subscribers

Query parameters

limitinteger required

The number of subscribers to return per page. Default 10

Example:10

The number of subscribers to return per page. Default 10

offsetinteger required

The offset used for pagination. Default 0

The offset used for pagination. Default 0

Response

Success

Example response

{
  "data": {
    "list": [
      {
        "view": "x",
        "avatar": "https://public.onlyfans.com/files/.../avatar.jpg",
        "avatarThumbs": {
          "c50": "https://thumbs.onlyfans.com/public/files/thumbs/c50/.../avatar.jpg",
          "c144": "https://thumbs.onlyfans.com/public/files/thumbs/c144/.../avatar.jpg"
        },
        "header": "https://public.onlyfans.com/files/.../header.jpg",
        "headerSize": {
          "width": 2160,
          "height": 2700
        },
        "headerThumbs": {
          "w480": "https://thumbs.onlyfans.com/public/files/thumbs/w480/.../header.jpg",
          "w760": "https://thumbs.onlyfans.com/public/files/thumbs/w760/.../header.jpg"
        },
        "id": 123,
        "name": "name",
        "username": "username",
        "canLookStory": true,
        "canCommentStory": true,
        "hasNotViewedStory": false,
        "isVerified": false,
        "canPayInternal": true,
        "hasScheduledStream": false,
        "hasStream": false,
        "hasStories": false,
        "tipsEnabled": false,
        "tipsTextEnabled": true,
        "tipsMin": 5,
        "tipsMinInternal": 1,
        "tipsMax": 200,
        "canEarn": false,
        "canAddSubscriber": false,
        "subscribePrice": 0,
        "displayName": "",
        "notice": "",
        "isRestricted": false,
        "canRestrict": true,
        "subscribedBy": true,
        "subscribedByExpire": false,
        "subscribedByExpireDate": "2025-01-01T00:00:00+00:00",
        "subscribedByAutoprolong": true,
        "subscribedIsExpiredNow": false,
        "currentSubscribePrice": 0,
        "subscribedOn": true,
        "subscribedOnExpiredNow": false,
        "subscribedOnDuration": "3 days",
        "listsStates": [
          {
            "id": "fans",
            "type": "fans",
            "name": "Fans",
            "hasUser": true,
            "canAddUser": false,
            "cannotAddUserReason": "ALREADY_EXISTS"
          },
          {
            "id": "following",
            "type": "following",
            "name": "Following",
            "hasUser": true,
            "canAddUser": false,
            "cannotAddUserReason": "ALREADY_EXISTS"
          },
          {
            "id": "friends",
            "type": "friends",
            "name": "Friends",
            "hasUser": false,
            "canAddUser": false,
            "cannotAddUserReason": "USER_NOT_PERFORMER"
          },
          {
            "id": "muted",
            "type": "muted",
            "name": "Muted",
            "hasUser": false,
            "canAddUser": true,
            "cannotAddUserReason": null
          },
          {
            "id": "recent",
            "type": "recent",
            "name": "Recent (last 24 hours)",
            "hasUser": false,
            "canAddUser": false,
            "cannotAddUserReason": "SYSTEM_LIST"
          },
          {
            "id": "rebill_off",
            "type": "rebill_off",
            "name": "Renew Off",
            "hasUser": true,
            "canAddUser": false,
            "cannotAddUserReason": "ALREADY_EXISTS"
          },
          {
            "id": "rebill_on",
            "type": "rebill_on",
            "name": "Renew On",
            "hasUser": false,
            "canAddUser": false,
            "cannotAddUserReason": null
          },
          {
            "id": "tagged",
            "type": "tagged",
            "name": "Tagged",
            "hasUser": false,
            "canAddUser": false,
            "cannotAddUserReason": "SYSTEM_LIST"
          }
        ],
        "canReport": true,
        "canReceiveChatMessage": true,
        "hideChat": false,
        "lastSeen": "2025-01-01T00:00:00+00:00",
        "isPerformer": false,
        "isRealPerformer": false,
        "subscribedByData": {
          "price": 0,
          "newPrice": 0,
          "regularPrice": 0,
          "subscribePrice": 0,
          "discountPercent": 0,
          "discountPeriod": 1,
          "subscribeAt": "2025-01-01T00:00:00+00:00",
          "expiredAt": "2025-01-01T00:00:00+00:00",
          "renewedAt": "2025-01-01T00:00:00+00:00",
          "discountFinishedAt": null,
          "discountStartedAt": null,
          "status": null,
          "isMuted": false,
          "unsubscribeReason": "No reason given",
          "duration": "3 days",
          "showPostsInFeed": true,
          "subscribes": [
            {
              "id": 123,
              "userId": 123,
              "subscriberId": 123,
              "date": "2025-01-01T00:00:00+00:00",
              "duration": 123,
              "startDate": "2025-01-01T00:00:00+00:00",
              "expireDate": "2025-01-01T00:00:00+00:00",
              "cancelDate": null,
              "price": 0,
              "regularPrice": 0,
              "discount": 0,
              "earningId": 0,
              "action": "subscribe",
              "type": "auto",
              "offerStart": null,
              "offerEnd": null,
              "isCurrent": true
            }
          ],
          "hasActivePaidSubscriptions": false
        },
        "subscribedOnData": {
          "price": 0,
          "newPrice": 0,
          "regularPrice": 5,
          "subscribePrice": 5,
          "discountPercent": 0,
          "discountPeriod": 1,
          "subscribeAt": "2025-01-01T00:00:00+00:00",
          "expiredAt": "2025-01-01T00:00:00+00:00",
          "renewedAt": null,
          "discountFinishedAt": null,
          "discountStartedAt": null,
          "status": "Set to Expire",
          "isMuted": false,
          "unsubscribeReason": "No reason given",
          "duration": "3 days",
          "tipsSumm": 0,
          "subscribesSumm": 0,
          "messagesSumm": 0,
          "postsSumm": 0,
          "streamsSumm": 0,
          "totalSumm": 0,
          "lastActivity": "2025-01-01T00:00:00+00:00",
          "recommendations": 0,
          "subscribes": [
            {
              "id": 123,
              "userId": 123,
              "subscriberId": 123,
              "date": "2025-01-01T00:00:00+00:00",
              "duration": 90,
              "startDate": "2025-01-01T00:00:00+00:00",
              "expireDate": "2025-01-01T00:00:00+00:00",
              "cancelDate": null,
              "price": 0,
              "regularPrice": 5,
              "discount": 0,
              "earningId": 0,
              "action": "subscribe",
              "type": "trial",
              "offerStart": "2025-01-01T00:00:00+00:00",
              "offerEnd": null,
              "isCurrent": true
            }
          ],
          "hasActivePaidSubscriptions": false
        },
        "canTrialSend": false,
        "isBlocked": false,
        "promoOffers": [
          {
            "id": 123,
            "subscribeDays": 90,
            "createdAt": "2025-01-01T00:00:00+00:00",
            "expiredAt": null,
            "finishedAt": "2025-01-01T00:00:00+00:00",
            "subscriberId": "123",
            "userId": "123"
          }
        ],
        "canUnsubscribe": true,
        "isPendingAutoprolong": false
      }
    ],
    "hasMore": true
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 1000000028,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 10000000,
      "limit_day": 50000,
      "remaining_minute": 9999999,
      "remaining_day": 49998
    }
  }
}

Changes

Changed in 1 of the 8 revisions of this API.12

  • 93a6dfdeeb6712See the full diff
    • ▲

      the response property data/list/items/promoOffers/items/expiredAt became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedByData/discountFinishedAt became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedByData/discountStartedAt became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedByData/status became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedByData/subscribes/items/cancelDate became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedByData/subscribes/items/offerEnd became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedByData/subscribes/items/offerStart became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedOnData/discountFinishedAt became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedOnData/discountStartedAt became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedOnData/renewedAt became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedOnData/subscribes/items/cancelDate became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/list/items/subscribedOnData/subscribes/items/offerEnd became nullable for the status 200

      response-property-became-nullable