Skip to main content
GET
/
v2
/
access
/
users
/
list
List users by IDs
curl --request GET \
  --url https://api-next.ofauth.com/v2/access/users/list \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "users": [
    {
      "id": 123,
      "username": "<string>",
      "name": "<string>",
      "isVerified": true,
      "avatar": "<string>",
      "lists": [
        {
          "id": "<string>",
          "type": "<string>",
          "name": "<string>"
        }
      ],
      "avatarThumbs": {
        "c50": "<string>",
        "c144": "<string>"
      },
      "displayName": "<string>",
      "notice": "<string>",
      "about": "<string>",
      "isMarkdownDisabledForAbout": true,
      "website": "<string>",
      "wishlist": "<string>",
      "location": "<string>",
      "header": "<string>",
      "headerSize": {
        "width": 123,
        "height": 123
      },
      "headerThumbs": {
        "w480": "<string>",
        "w760": "<string>"
      },
      "subscribersCount": 123,
      "postsCount": 123,
      "archivedPostsCount": 123,
      "privateArchivedPostsCount": 123,
      "photosCount": 123,
      "videosCount": 123,
      "audiosCount": 123,
      "mediasCount": 123,
      "favoritesCount": 123,
      "favoritedCount": 123,
      "joinDate": "<string>",
      "lastSeen": "<string>",
      "subscribedBy": true,
      "subscribedByExpire": true,
      "subscribedByExpireDate": "<string>",
      "subscribedByAutoprolong": true,
      "subscribedIsExpiredNow": true,
      "subscribedByData": {
        "price": 123,
        "newPrice": 123,
        "regularPrice": 123,
        "subscribePrice": 123,
        "discountPercent": 123,
        "discountPeriod": 123,
        "subscribeAt": "<string>",
        "expiredAt": "<string>",
        "renewedAt": "<string>",
        "discountFinishedAt": "<string>",
        "discountStartedAt": "<string>",
        "status": "<string>",
        "isMuted": true,
        "unsubscribeReason": "<string>",
        "duration": "<string>",
        "hasActivePaidSubscriptions": true,
        "showPostsInFeed": true,
        "subscribes": [
          {
            "id": 123,
            "userId": 123,
            "subscriberId": 123,
            "date": "<string>",
            "duration": 123,
            "startDate": "<string>",
            "expireDate": "<string>",
            "cancelDate": "<string>",
            "price": 123,
            "regularPrice": 123,
            "discount": 123,
            "earningId": 123,
            "action": "<string>",
            "type": "<string>",
            "offerStart": "<string>",
            "offerEnd": "<string>",
            "isCurrent": true
          }
        ]
      },
      "subscribedOn": true,
      "subscribedOnExpiredNow": true,
      "subscribedOnDuration": "<string>",
      "subscribedOnData": {
        "price": 123,
        "newPrice": 123,
        "regularPrice": 123,
        "subscribePrice": 123,
        "discountPercent": 123,
        "discountPeriod": 123,
        "subscribeAt": "<string>",
        "expiredAt": "<string>",
        "renewedAt": "<string>",
        "discountFinishedAt": "<string>",
        "discountStartedAt": "<string>",
        "status": "<string>",
        "isMuted": true,
        "unsubscribeReason": "<string>",
        "duration": "<string>",
        "hasActivePaidSubscriptions": true,
        "subscribes": [
          {
            "id": 123,
            "userId": 123,
            "subscriberId": 123,
            "date": "<string>",
            "duration": 123,
            "startDate": "<string>",
            "expireDate": "<string>",
            "cancelDate": "<string>",
            "price": 123,
            "regularPrice": 123,
            "discount": 123,
            "earningId": 123,
            "action": "<string>",
            "type": "<string>",
            "offerStart": "<string>",
            "offerEnd": "<string>",
            "isCurrent": true
          }
        ],
        "tipsSumm": 123,
        "subscribesSumm": 123,
        "messagesSumm": 123,
        "postsSumm": 123,
        "streamsSumm": 123,
        "totalSumm": 123
      },
      "subscribePrice": 123,
      "currentSubscribePrice": 123,
      "canAddSubscriber": true,
      "tipsEnabled": true,
      "tipsTextEnabled": true,
      "tipsMin": 123,
      "tipsMinInternal": 123,
      "tipsMax": 123,
      "canLookStory": true,
      "canCommentStory": true,
      "hasNotViewedStory": true,
      "hasStories": true,
      "isRestricted": true,
      "canRestrict": true,
      "isBlocked": true,
      "canReport": true,
      "canUnsubscribe": true,
      "isPendingAutoprolong": true,
      "isPerformer": true,
      "isRealPerformer": true,
      "canReceiveChatMessage": true,
      "canChat": true,
      "showPostsInFeed": true,
      "hasPinnedPosts": true,
      "hasLabels": true,
      "isPrivateRestriction": true,
      "showSubscribersCount": true,
      "showMediaCount": true,
      "isReferrerAllowed": true,
      "canCreatePromotion": true,
      "canCreateTrial": true,
      "isAdultContent": true,
      "canTrialSend": true,
      "isFriend": true,
      "hasScheduledStream": true,
      "hasStream": true,
      "canPayInternal": true
    }
  ]
}

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Query Parameters

userIds
required

User IDs to fetch (comma-separated string or array)

Required array length: 1 - 10 elements

Response

Successful response

users
object[]
required