We just released our native n8n integration!ยป Try now
OnlyFans API
Users

Mass-List User Details

Save on credits by getting up to 10 user details with a single request. User details are retrieved using the current {account} so fields like subscribedOnData which include potential subscription details will be included.

GET
/api/{account}/users/list
AuthorizationBearer <token>

Get your API Key from OnlyFansAPI Console - https://app.onlyfansapi.com/api-keys

In: header

Path Parameters

account*string

The Account ID

Query Parameters

ids*string

Comma-separated list of user IDs (max. 10 IDs). Must be at least 1 character.

Response Body

application/json

curl -X GET "https://app.onlyfansapi.com/api/acct_XXXXXXXXXXXXXXX/users/list?ids=12412412%2C36139491%2C1858349"
{
  "data": {
    "1000000": {
      "view": "f",
      "avatar": "https://example.com/redacted.jpg",
      "avatarThumbs": {
        "c50": "https://example.com/redacted.jpg",
        "c144": "https://example.com/redacted.jpg"
      },
      "header": null,
      "headerSize": null,
      "headerThumbs": null,
      "id": 1000000,
      "name": "Example User",
      "username": "example_user",
      "canLookStory": true,
      "canCommentStory": true,
      "hasNotViewedStory": false,
      "isVerified": true,
      "canPayInternal": true,
      "hasScheduledStream": false,
      "hasStream": false,
      "hasStories": false,
      "tipsEnabled": false,
      "tipsTextEnabled": true,
      "tipsMin": 5,
      "tipsMinInternal": 1,
      "tipsMax": 200,
      "canEarn": true,
      "canAddSubscriber": false,
      "subscribePrice": 0,
      "displayName": "Example User",
      "notice": "",
      "isPaywallRequired": true,
      "isActive": true,
      "isRestricted": false,
      "canRestrict": true,
      "subscribedBy": true,
      "subscribedByExpire": false,
      "subscribedByExpireDate": "2024-01-01T00:00:00+00:00",
      "subscribedByAutoprolong": false,
      "subscribedIsExpiredNow": false,
      "currentSubscribePrice": 0,
      "subscribedOn": null,
      "subscribedOnExpiredNow": true,
      "subscribedOnDuration": "1 month",
      "listsStates": [
        {
          "id": "redacted_id",
          "type": "muted",
          "name": "Example User",
          "hasUser": false,
          "canAddUser": true,
          "cannotAddUserReason": null
        },
        {
          "id": "redacted_id",
          "type": "fans",
          "name": "Example User",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": null
        },
        {
          "id": "redacted_id",
          "type": "following",
          "name": "Example User",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "redacted_id",
          "type": "recent",
          "name": "Example User",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        },
        {
          "id": "redacted_id",
          "type": "friends",
          "name": "Example User",
          "hasUser": false,
          "canAddUser": true,
          "cannotAddUserReason": null
        },
        {
          "id": 1000000,
          "type": "custom",
          "name": "Example User",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": 1000000,
          "type": "custom",
          "name": "Example User",
          "hasUser": true,
          "canAddUser": false,
          "cannotAddUserReason": "ALREADY_EXISTS"
        },
        {
          "id": "redacted_id",
          "type": "rebill_off",
          "name": "Example User",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": null
        },
        {
          "id": "redacted_id",
          "type": "rebill_on",
          "name": "Example User",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": null
        },
        {
          "id": "redacted_id",
          "type": "tagged",
          "name": "Example User",
          "hasUser": false,
          "canAddUser": false,
          "cannotAddUserReason": "SYSTEM_LIST"
        }
      ],
      "joinDate": "2024-01-01T00:00:00+00:00",
      "isReferrerAllowed": true,
      "about": "",
      "isMarkdownDisabledForAbout": false,
      "website": null,
      "wishlist": null,
      "location": null,
      "postsCount": 0,
      "archivedPostsCount": 0,
      "privateArchivedPostsCount": 0,
      "photosCount": 0,
      "videosCount": 0,
      "audiosCount": 0,
      "mediasCount": 0,
      "lastSeen": "2024-01-01T00:00:00+00:00",
      "favoritesCount": 0,
      "favoritedCount": 0,
      "showPostsInFeed": true,
      "canReceiveChatMessage": true,
      "isPerformer": true,
      "isRealPerformer": true,
      "isSpotifyConnected": false,
      "subscribersCount": null,
      "hasPinnedPosts": false,
      "hasLabels": false,
      "canChat": true,
      "avatarHeaderConverterUpload": true,
      "isPrivateRestriction": false,
      "showSubscribersCount": false,
      "showMediaCount": true,
      "subscribedByData": {
        "price": 0,
        "newPrice": 0,
        "regularPrice": 0,
        "subscribePrice": 0,
        "discountPercent": 0,
        "discountPeriod": 1,
        "subscribeAt": "2024-01-01T00:00:00+00:00",
        "expiredAt": "2024-01-01T00:00:00+00:00",
        "renewedAt": null,
        "discountFinishedAt": null,
        "discountStartedAt": null,
        "status": "Set to Expire",
        "isMuted": false,
        "unsubscribeReason": "Redacted",
        "duration": "6 months",
        "showPostsInFeed": true,
        "subscribes": [
          {
            "id": 1000000,
            "userId": 1000000,
            "subscriberId": 1000000,
            "date": "2024-01-01T00:00:00+00:00",
            "duration": 3652,
            "startDate": "2024-01-01T00:00:00+00:00",
            "expireDate": "2024-01-01T00:00:00+00:00",
            "cancelDate": null,
            "price": 0,
            "regularPrice": 0,
            "discount": 0,
            "earningId": 0,
            "action": "subscribe",
            "type": "regular",
            "offerStart": null,
            "offerEnd": null,
            "isCurrent": true
          },
          {
            "id": 1000000,
            "userId": 1000000,
            "subscriberId": 1000000,
            "date": "2024-01-01T00:00:00+00:00",
            "duration": 3652,
            "startDate": "2024-01-01T00:00:00+00:00",
            "expireDate": "2024-01-01T00:00:00+00:00",
            "cancelDate": null,
            "price": 0,
            "regularPrice": 0,
            "discount": 0,
            "earningId": 0,
            "action": "prolong",
            "type": "regular",
            "offerStart": null,
            "offerEnd": null,
            "isCurrent": true
          }
        ],
        "hasActivePaidSubscriptions": false
      },
      "subscribedOnData": {
        "price": 3.9,
        "newPrice": 12.99,
        "regularPrice": 12.99,
        "subscribePrice": 12.99,
        "discountPercent": 0,
        "discountPeriod": 1,
        "subscribeAt": "2024-01-01T00:00:00+00:00",
        "expiredAt": "2024-01-01T00:00:00+00:00",
        "renewedAt": null,
        "discountFinishedAt": null,
        "discountStartedAt": null,
        "status": null,
        "isMuted": false,
        "unsubscribeReason": "Redacted",
        "duration": "8 months",
        "tipsSumm": 0,
        "subscribesSumm": 0,
        "messagesSumm": 0,
        "postsSumm": 0,
        "streamsSumm": 0,
        "totalSumm": 0,
        "subscribes": [],
        "hasActivePaidSubscriptions": false
      },
      "canCreatePromotion": false,
      "canCreateTrial": false,
      "isAdultContent": false,
      "canTrialSend": true,
      "hasLinks": false,
      "hasFriends": true,
      "firstPublishedPostDate": "2024-01-01T00:00:00+00:00",
      "isSpringConnected": false,
      "isFriend": false,
      "isBlocked": false,
      "canReport": true,
      "canUnsubscribe": true,
      "isPendingAutoprolong": false
    }
  },
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 380044,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 5000,
      "limit_day": null,
      "remaining_minute": 4999,
      "remaining_day": null,
      "notice": "We have decided to remove our daily rate limits. Please remove any references to these in your integrations."
    }
  }
}