Get user

Get user

Permission Required: profile:read

GET /v2/access/users/:userId

Get user

cURL

curl --request GET \
  --url https://api.ofauth.com/v2/access/users/:userId \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'

200

{
  "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.

Path Parameters

userId · string | null

User ID (numeric or username)

Minimum string length: 1

Response

200

application/json

Successful response

Option 1

Option 2

id · number · required

username · string · required

name · string · required

isVerified · boolean · required

avatar · string | null · required

lists · object[] · required

Show child attributes

avatarThumbs · object

Show child attributes

displayName · string

notice · string

about · string | null

isMarkdownDisabledForAbout · boolean

website · string | null

wishlist · string | null

location · string | null

header · string | null

headerSize · object

Show child attributes

headerThumbs · object

Show child attributes

subscribersCount · number | null

postsCount · number

archivedPostsCount · number

privateArchivedPostsCount · number

photosCount · number

videosCount · number

audiosCount · number

mediasCount · number

favoritesCount · number

favoritedCount · number

joinDate · string

lastSeen · string | null

subscribedBy · boolean

subscribedByExpire · boolean | null

subscribedByExpireDate · string | null

subscribedByAutoprolong · boolean | null

subscribedIsExpiredNow · boolean | null

subscribedByData · object

Show child attributes

subscribedOn · boolean

subscribedOnExpiredNow · boolean

subscribedOnDuration · string

subscribedOnData · object

Show child attributes

subscribePrice · number

currentSubscribePrice · number | null

canAddSubscriber · boolean

tipsEnabled · boolean

tipsTextEnabled · boolean

tipsMin · number

tipsMinInternal · number

tipsMax · number

canLookStory · boolean

canCommentStory · boolean

hasNotViewedStory · boolean

hasStories · boolean

isRestricted · boolean

canRestrict · boolean

isBlocked · boolean

canReport · boolean

canUnsubscribe · boolean

isPendingAutoprolong · boolean

isPerformer · boolean

isRealPerformer · boolean

canReceiveChatMessage · boolean

canChat · boolean

showPostsInFeed · boolean

hasPinnedPosts · boolean

hasLabels · boolean

isPrivateRestriction · boolean

showSubscribersCount · boolean

showMediaCount · boolean

isReferrerAllowed · boolean

canCreatePromotion · boolean

canCreateTrial · boolean

isAdultContent · boolean

canTrialSend · boolean

isFriend · boolean

hasScheduledStream · boolean

hasStream · boolean

canPayInternal · boolean