> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ofauth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Batch get users

> Get up to 10 users by ID in one OnlyFans call. Each user has the fields OnlyFans returns in its `m` user view: identity (`id`, `name`, `username`, `avatar`, `avatarThumbs`, `isVerified`) and, depending on the user, relation, subscription, price, tips and header fields. Only `id` is always present. For the full profile (about, counts, join date) use `GET /v3/access/users/{userId}`. Users come back in request order; IDs OnlyFans cannot return are left out.

**Required scope:** `users:read`



## OpenAPI

````yaml /openapi/v3.json post /v3/access/users/batch
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth V3 API for linking accounts, making OnlyFans API requests, and
    receiving events.
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ExternalOAuth: []
tags:
  - name: Link
    description: Link accounts, get and refresh tokens, and end access.
  - name: Linked accounts
    description: The linked accounts of one authorization, and their settings.
  - name: Access
    description: Make OnlyFans API requests for a linked account.
  - name: Analytics
    description: 'Access: charts, rankings, and performance data.'
  - name: Earnings
    description: 'Access: earnings charts, transactions, and chargebacks.'
  - name: Messages
    description: 'Access: messaging, chats, queue, and mass messaging.'
  - name: Posts
    description: 'Access: create, edit, list, and manage posts.'
  - name: Promotions
    description: 'Access: promotions, trials, and bundles.'
  - name: Users
    description: 'Access: user profiles, subscriptions, and actions.'
  - name: Vault
    description: 'Access: vault folders, media, and management.'
  - name: Upload
    description: 'Access: media upload and processing.'
  - name: Self
    description: 'Access: linked account profile and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: Webhook event formats, including OnlyFans activity events.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v3/access/users/batch:
    post:
      tags:
        - Users
      summary: Batch get users
      description: >-
        Get up to 10 users by ID in one OnlyFans call. Each user has the fields
        OnlyFans returns in its `m` user view: identity (`id`, `name`,
        `username`, `avatar`, `avatarThumbs`, `isVerified`) and, depending on
        the user, relation, subscription, price, tips and header fields. Only
        `id` is always present. For the full profile (about, counts, join date)
        use `GET /v3/access/users/{userId}`. Users come back in request order;
        IDs OnlyFans cannot return are left out.


        **Required scope:** `users:read`
      operationId: access.users.batch
      parameters:
        - name: x-linked-account-id
          in: header
          required: true
          description: >-
            The linked account to use. The user must have shared it with your
            app. A missing account returns `linked_account_required`; an account
            outside your access returns `linked_account_not_granted`.
          schema:
            type: string
            example: conn_example123
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userIds:
                  type: array
                  items:
                    type: string
                    pattern: ^[1-9]\d*$
                  minItems: 1
                  maxItems: 10
                  description: >-
                    Numeric OnlyFans user IDs to fetch, 1 to 10 per request (one
                    OnlyFans call).
              required:
                - userIds
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        username:
                          type: string
                        name:
                          type: string
                        displayName:
                          type: string
                        isVerified:
                          type: boolean
                        avatar:
                          type: string
                          nullable: true
                        avatarThumbs:
                          type: object
                          nullable: true
                          additionalProperties:
                            type: string
                        lists:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                anyOf:
                                  - type: string
                                  - type: number
                              type:
                                type: string
                              name:
                                type: string
                            required:
                              - id
                              - type
                              - name
                        notice:
                          type: string
                        about:
                          type: string
                          nullable: true
                        isMarkdownDisabledForAbout:
                          type: boolean
                        website:
                          type: string
                          nullable: true
                        wishlist:
                          type: string
                          nullable: true
                        location:
                          type: string
                          nullable: true
                        header:
                          type: string
                          nullable: true
                        headerSize:
                          type: object
                          nullable: true
                          properties:
                            width:
                              type: number
                            height:
                              type: number
                          required:
                            - width
                            - height
                        headerThumbs:
                          type: object
                          nullable: true
                          properties:
                            w480:
                              type: string
                            w760:
                              type: string
                          required:
                            - w480
                            - w760
                        subscribersCount:
                          type: number
                          nullable: true
                        postsCount:
                          type: number
                        archivedPostsCount:
                          type: number
                        privateArchivedPostsCount:
                          type: number
                        photosCount:
                          type: number
                        videosCount:
                          type: number
                        audiosCount:
                          type: number
                        mediasCount:
                          type: number
                        favoritesCount:
                          type: number
                        favoritedCount:
                          type: number
                        joinDate:
                          type: string
                        lastSeen:
                          type: string
                          nullable: true
                        subscribedBy:
                          type: boolean
                        subscribedByExpire:
                          type: boolean
                          nullable: true
                        subscribedByExpireDate:
                          type: string
                          nullable: true
                        subscribedByAutoprolong:
                          type: boolean
                          nullable: true
                        subscribedIsExpiredNow:
                          type: boolean
                          nullable: true
                        subscribedByData:
                          type: object
                          nullable: true
                          properties:
                            price:
                              type: number
                            newPrice:
                              type: number
                            regularPrice:
                              type: number
                            subscribePrice:
                              type: number
                            discountPercent:
                              type: number
                            discountPeriod:
                              type: number
                            subscribeAt:
                              type: string
                            expiredAt:
                              type: string
                            renewedAt:
                              type: string
                              nullable: true
                            discountFinishedAt:
                              type: string
                              nullable: true
                            discountStartedAt:
                              type: string
                              nullable: true
                            status:
                              type: string
                              nullable: true
                            isMuted:
                              type: boolean
                            unsubscribeReason:
                              type: string
                            duration:
                              type: string
                            hasActivePaidSubscriptions:
                              type: boolean
                            showPostsInFeed:
                              type: boolean
                            subscribes:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  userId:
                                    type: number
                                  subscriberId:
                                    type: number
                                  date:
                                    type: string
                                  duration:
                                    type: number
                                  startDate:
                                    type: string
                                  expireDate:
                                    type: string
                                  cancelDate:
                                    type: string
                                    nullable: true
                                  price:
                                    type: number
                                  regularPrice:
                                    type: number
                                  discount:
                                    type: number
                                  earningId:
                                    type: number
                                  action:
                                    type: string
                                  type:
                                    type: string
                                  offerStart:
                                    type: string
                                    nullable: true
                                  offerEnd:
                                    type: string
                                    nullable: true
                                  isCurrent:
                                    type: boolean
                                required:
                                  - id
                                  - userId
                                  - subscriberId
                                  - date
                                  - duration
                                  - startDate
                                  - expireDate
                                  - cancelDate
                                  - price
                                  - regularPrice
                                  - discount
                                  - earningId
                                  - action
                                  - type
                                  - offerStart
                                  - offerEnd
                                  - isCurrent
                        subscribedOn:
                          type: boolean
                        subscribedOnExpiredNow:
                          type: boolean
                        subscribedOnDuration:
                          type: string
                        subscribedOnData:
                          type: object
                          nullable: true
                          properties:
                            price:
                              type: number
                            newPrice:
                              type: number
                            regularPrice:
                              type: number
                            subscribePrice:
                              type: number
                            discountPercent:
                              type: number
                            discountPeriod:
                              type: number
                            subscribeAt:
                              type: string
                            expiredAt:
                              type: string
                            renewedAt:
                              type: string
                              nullable: true
                            discountFinishedAt:
                              type: string
                              nullable: true
                            discountStartedAt:
                              type: string
                              nullable: true
                            status:
                              type: string
                              nullable: true
                            isMuted:
                              type: boolean
                            unsubscribeReason:
                              type: string
                            duration:
                              type: string
                            hasActivePaidSubscriptions:
                              type: boolean
                            subscribes:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  userId:
                                    type: number
                                  subscriberId:
                                    type: number
                                  date:
                                    type: string
                                  duration:
                                    type: number
                                  startDate:
                                    type: string
                                  expireDate:
                                    type: string
                                  cancelDate:
                                    type: string
                                    nullable: true
                                  price:
                                    type: number
                                  regularPrice:
                                    type: number
                                  discount:
                                    type: number
                                  earningId:
                                    type: number
                                  action:
                                    type: string
                                  type:
                                    type: string
                                  offerStart:
                                    type: string
                                    nullable: true
                                  offerEnd:
                                    type: string
                                    nullable: true
                                  isCurrent:
                                    type: boolean
                                required:
                                  - id
                                  - userId
                                  - subscriberId
                                  - date
                                  - duration
                                  - startDate
                                  - expireDate
                                  - cancelDate
                                  - price
                                  - regularPrice
                                  - discount
                                  - earningId
                                  - action
                                  - type
                                  - offerStart
                                  - offerEnd
                                  - isCurrent
                            tipsSumm:
                              type: number
                            subscribesSumm:
                              type: number
                            messagesSumm:
                              type: number
                            postsSumm:
                              type: number
                            streamsSumm:
                              type: number
                            totalSumm:
                              type: number
                        subscribePrice:
                          type: number
                        currentSubscribePrice:
                          type: number
                          nullable: true
                        canAddSubscriber:
                          type: boolean
                        tipsEnabled:
                          type: boolean
                        tipsTextEnabled:
                          type: boolean
                        tipsMin:
                          type: number
                        tipsMinInternal:
                          type: number
                        tipsMax:
                          type: number
                        canLookStory:
                          type: boolean
                        canCommentStory:
                          type: boolean
                        hasNotViewedStory:
                          type: boolean
                        hasStories:
                          type: boolean
                        isRestricted:
                          type: boolean
                        canRestrict:
                          type: boolean
                        isBlocked:
                          type: boolean
                        canReport:
                          type: boolean
                        canUnsubscribe:
                          type: boolean
                        isPendingAutoprolong:
                          type: boolean
                        isPerformer:
                          type: boolean
                        isRealPerformer:
                          type: boolean
                        canReceiveChatMessage:
                          type: boolean
                        canChat:
                          type: boolean
                        showPostsInFeed:
                          type: boolean
                        hasPinnedPosts:
                          type: boolean
                        hasLabels:
                          type: boolean
                        isPrivateRestriction:
                          type: boolean
                        showSubscribersCount:
                          type: boolean
                        showMediaCount:
                          type: boolean
                        isReferrerAllowed:
                          type: boolean
                        canCreatePromotion:
                          type: boolean
                        canCreateTrial:
                          type: boolean
                        isAdultContent:
                          type: boolean
                        canTrialSend:
                          type: boolean
                        isFriend:
                          type: boolean
                        hasScheduledStream:
                          type: boolean
                        hasStream:
                          type: boolean
                        canPayInternal:
                          type: boolean
                      required:
                        - id
                        - username
                        - name
                        - isVerified
                        - avatar
                        - lists
                required:
                  - users
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Rate Limit Exceeded
        '500':
          description: Internal Server Error
        '502':
          description: Bad Gateway
      deprecated: false
      security:
        - ExternalOAuth: []
          LinkedAccountId: []
components:
  securitySchemes:
    ExternalOAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: Link access token for one Sandbox, Test, or Live authorization.
    LinkedAccountId:
      type: apiKey
      name: x-linked-account-id
      in: header
      description: >-
        Selects one of the authorization's linked accounts via the
        x-linked-account-id header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.