> ## 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.

# Pinned list users

> List pinned users in a list.

**Required scope:** `lists:read`



## OpenAPI

````yaml /openapi/v3.json get /v3/access/lists/:listId/users/pinned
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/lists/:listId/users/pinned:
    get:
      tags:
        - Lists
      summary: Pinned list users
      description: |-
        List pinned users in a list.

        **Required scope:** `lists:read`
      operationId: access.lists.users.listPinned
      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
        - schema:
            anyOf:
              - type: string
                pattern: ^\d+$
              - type: string
                enum:
                  - friends
                  - rebill_off
                  - rebill_on
                  - recent
          required: true
          name: listId
          in: path
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        avatar:
                          nullable: true
                        avatarThumbs:
                          nullable: true
                        canAddSubscriber:
                          type: boolean
                          nullable: true
                        canCommentStory:
                          type: boolean
                          nullable: true
                        canEarn:
                          type: boolean
                          nullable: true
                        canLookStory:
                          type: boolean
                          nullable: true
                        canPayInternal:
                          type: boolean
                          nullable: true
                        canReceiveChatMessage:
                          type: boolean
                          nullable: true
                        canReport:
                          type: boolean
                          nullable: true
                        canRestrict:
                          type: boolean
                          nullable: true
                        canTrialSend:
                          type: boolean
                          nullable: true
                        canUnsubscribe:
                          type: boolean
                          nullable: true
                        currentSubscribePrice:
                          type: number
                          nullable: true
                        displayName:
                          type: string
                          nullable: true
                        hasNotViewedStory:
                          type: boolean
                          nullable: true
                        hasScheduledStream:
                          type: boolean
                          nullable: true
                        hasStories:
                          type: boolean
                          nullable: true
                        hasStream:
                          type: boolean
                          nullable: true
                        header:
                          nullable: true
                        headerSize:
                          nullable: true
                        headerThumbs:
                          nullable: true
                        hideChat:
                          type: boolean
                          nullable: true
                        id:
                          type: number
                          nullable: true
                        isActive:
                          type: boolean
                          nullable: true
                        isBlocked:
                          type: boolean
                          nullable: true
                        isPaywallRequired:
                          type: boolean
                          nullable: true
                        isPendingAutoprolong:
                          type: boolean
                          nullable: true
                        isPerformer:
                          type: boolean
                          nullable: true
                        isRealPerformer:
                          type: boolean
                          nullable: true
                        isRestricted:
                          type: boolean
                          nullable: true
                        isVerified:
                          type: boolean
                          nullable: true
                        lastSeen:
                          nullable: true
                        listsStates:
                          type: array
                          items:
                            anyOf:
                              - type: object
                                properties:
                                  canAddUser:
                                    type: boolean
                                    nullable: true
                                  cannotAddUserReason:
                                    anyOf:
                                      - nullable: true
                                      - type: string
                                      - nullable: true
                                  hasUser:
                                    type: boolean
                                    nullable: true
                                  id:
                                    type: string
                                    nullable: true
                                  name:
                                    type: string
                                    nullable: true
                                  type:
                                    type: string
                                    nullable: true
                              - type: array
                                items:
                                  nullable: true
                              - nullable: true
                        name:
                          type: string
                          nullable: true
                        notice:
                          type: string
                          nullable: true
                        promoOffers:
                          type: array
                          items:
                            nullable: true
                        subscribedBy:
                          type: boolean
                          nullable: true
                        subscribedByAutoprolong:
                          type: boolean
                          nullable: true
                        subscribedByData:
                          anyOf:
                            - type: object
                              properties:
                                discountFinishedAt:
                                  nullable: true
                                discountPercent:
                                  type: number
                                  nullable: true
                                discountPeriod:
                                  type: number
                                  nullable: true
                                discountStartedAt:
                                  nullable: true
                                duration:
                                  type: string
                                  nullable: true
                                expiredAt:
                                  type: string
                                  nullable: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  nullable: true
                                newPrice:
                                  type: number
                                  nullable: true
                                price:
                                  type: number
                                  nullable: true
                                regularPrice:
                                  type: number
                                  nullable: true
                                renewedAt:
                                  nullable: true
                                showPostsInFeed:
                                  type: boolean
                                  nullable: true
                                status:
                                  type: string
                                  nullable: true
                                subscribeAt:
                                  type: string
                                  nullable: true
                                subscribePrice:
                                  type: number
                                  nullable: true
                                subscribes:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: object
                                        properties:
                                          action:
                                            type: string
                                            nullable: true
                                          cancelDate:
                                            nullable: true
                                          date:
                                            type: string
                                            nullable: true
                                          discount:
                                            type: number
                                            nullable: true
                                          duration:
                                            type: number
                                            nullable: true
                                          earningId:
                                            type: number
                                            nullable: true
                                          expireDate:
                                            type: string
                                            nullable: true
                                          id:
                                            type: number
                                            nullable: true
                                          isCurrent:
                                            type: boolean
                                            nullable: true
                                          offerEnd:
                                            type: string
                                            nullable: true
                                          offerStart:
                                            type: string
                                            nullable: true
                                          price:
                                            type: number
                                            nullable: true
                                          regularPrice:
                                            type: number
                                            nullable: true
                                          startDate:
                                            type: string
                                            nullable: true
                                          subscriberId:
                                            type: number
                                            nullable: true
                                          type:
                                            type: string
                                            nullable: true
                                          userId:
                                            type: number
                                            nullable: true
                                      - type: array
                                        items:
                                          nullable: true
                                      - nullable: true
                                unsubscribeReason:
                                  type: string
                                  nullable: true
                            - type: array
                              items:
                                nullable: true
                            - nullable: true
                        subscribedByExpire:
                          type: boolean
                          nullable: true
                        subscribedByExpireDate:
                          type: string
                          nullable: true
                        subscribedIsExpiredNow:
                          type: boolean
                          nullable: true
                        subscribedOn:
                          type: boolean
                          nullable: true
                        subscribedOnData:
                          anyOf:
                            - type: object
                              properties:
                                discountFinishedAt:
                                  nullable: true
                                discountPercent:
                                  type: number
                                  nullable: true
                                discountPeriod:
                                  type: number
                                  nullable: true
                                discountStartedAt:
                                  nullable: true
                                duration:
                                  type: string
                                  nullable: true
                                expiredAt:
                                  type: string
                                  nullable: true
                                hasActivePaidSubscriptions:
                                  type: boolean
                                  nullable: true
                                isMuted:
                                  type: boolean
                                  nullable: true
                                lastActivity:
                                  type: string
                                  nullable: true
                                messagesSumm:
                                  type: number
                                  nullable: true
                                newPrice:
                                  type: number
                                  nullable: true
                                postsSumm:
                                  type: number
                                  nullable: true
                                price:
                                  type: number
                                  nullable: true
                                recommendations:
                                  type: number
                                  nullable: true
                                regularPrice:
                                  type: number
                                  nullable: true
                                renewedAt:
                                  nullable: true
                                status:
                                  type: string
                                  nullable: true
                                streamsSumm:
                                  type: number
                                  nullable: true
                                subscribeAt:
                                  type: string
                                  nullable: true
                                subscribePrice:
                                  type: number
                                  nullable: true
                                subscribes:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: object
                                        properties:
                                          action:
                                            type: string
                                            nullable: true
                                          cancelDate:
                                            nullable: true
                                          date:
                                            type: string
                                            nullable: true
                                          discount:
                                            type: number
                                            nullable: true
                                          duration:
                                            type: number
                                            nullable: true
                                          earningId:
                                            type: number
                                            nullable: true
                                          expireDate:
                                            type: string
                                            nullable: true
                                          id:
                                            type: number
                                            nullable: true
                                          isCurrent:
                                            type: boolean
                                            nullable: true
                                          offerEnd:
                                            type: string
                                            nullable: true
                                          offerStart:
                                            type: string
                                            nullable: true
                                          price:
                                            type: number
                                            nullable: true
                                          regularPrice:
                                            type: number
                                            nullable: true
                                          startDate:
                                            type: string
                                            nullable: true
                                          subscriberId:
                                            type: number
                                            nullable: true
                                          type:
                                            type: string
                                            nullable: true
                                          userId:
                                            type: number
                                            nullable: true
                                      - type: array
                                        items:
                                          nullable: true
                                      - nullable: true
                                subscribesSumm:
                                  type: number
                                  nullable: true
                                tipsSumm:
                                  type: number
                                  nullable: true
                                totalSumm:
                                  type: number
                                  nullable: true
                                unsubscribeReason:
                                  type: string
                                  nullable: true
                            - type: array
                              items:
                                nullable: true
                            - nullable: true
                        subscribedOnDuration:
                          type: string
                          nullable: true
                        subscribedOnExpiredNow:
                          type: boolean
                          nullable: true
                        subscribePrice:
                          type: number
                          nullable: true
                        subscriptionBundles:
                          type: array
                          items:
                            anyOf:
                              - type: object
                                properties:
                                  canBuy:
                                    type: boolean
                                    nullable: true
                                  discount:
                                    type: number
                                    nullable: true
                                  duration:
                                    type: number
                                    nullable: true
                                  id:
                                    type: number
                                    nullable: true
                                  price:
                                    type: number
                                    nullable: true
                              - type: array
                                items:
                                  nullable: true
                              - nullable: true
                        tipsEnabled:
                          type: boolean
                          nullable: true
                        tipsMax:
                          type: number
                          nullable: true
                        tipsMin:
                          type: number
                          nullable: true
                        tipsMinInternal:
                          type: number
                          nullable: true
                        tipsTextEnabled:
                          type: boolean
                          nullable: true
                        username:
                          type: string
                          nullable: true
                required:
                  - items
                additionalProperties: false
        '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.