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

# List user lists

> Get user lists created by the linked account, with fields to request more pages.

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



## OpenAPI

````yaml /openapi/v3.json get /v3/access/lists
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:
    get:
      tags:
        - Lists
      summary: List user lists
      description: >-
        Get user lists created by the linked account, with fields to request
        more pages.


        **Required scope:** `lists:read`
      operationId: access.lists.list
      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:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
            description: 'Number of items to return (1-100, default: 10)'
          required: false
          description: 'Number of items to return (1-100, default: 10)'
          name: limit
          in: query
        - schema:
            type: string
            nullable: true
            description: Cursor from the previous response. Send it to get the next page.
          required: false
          description: Cursor from the previous response. Send it to get the next page.
          name: cursor
          in: query
        - schema:
            type: string
            maxLength: 100
            description: Text to search for
          required: false
          description: Text to search for
          name: query
          in: query
        - schema:
            type: string
            enum:
              - locked
              - paid
              - pinned
              - priority
              - unread
              - who_tipped
            description: List filter
          required: false
          description: List filter
          name: filter
          in: query
        - schema:
            type: boolean
            nullable: true
            description: Only include chat lists
          required: false
          description: Only include chat lists
          name: isChat
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        canAddUsers:
                          type: boolean
                          nullable: true
                        canDelete:
                          type: boolean
                          nullable: true
                        canManageUsers:
                          type: boolean
                          nullable: true
                        canPinnedToChat:
                          type: boolean
                          nullable: true
                        canPinnedToFeed:
                          type: boolean
                          nullable: true
                        canUpdate:
                          type: boolean
                          nullable: true
                        direction:
                          type: string
                          nullable: true
                        id:
                          type: string
                          nullable: true
                        isPinnedToChat:
                          type: boolean
                          nullable: true
                        isPinnedToFeed:
                          type: boolean
                          nullable: true
                        name:
                          type: string
                          nullable: true
                        order:
                          type: string
                          nullable: true
                        postsCount:
                          type: number
                          nullable: true
                        sortList:
                          anyOf:
                            - type: object
                              properties:
                                activity:
                                  anyOf:
                                    - type: object
                                      properties:
                                        direction:
                                          type: string
                                          nullable: true
                                        order:
                                          type: string
                                          nullable: true
                                    - type: array
                                      items:
                                        nullable: true
                                    - nullable: true
                                all:
                                  anyOf:
                                    - type: object
                                      properties:
                                        direction:
                                          type: string
                                          nullable: true
                                        order:
                                          type: string
                                          nullable: true
                                    - type: array
                                      items:
                                        nullable: true
                                    - nullable: true
                                direction:
                                  type: string
                                  nullable: true
                                expired:
                                  anyOf:
                                    - type: object
                                      properties:
                                        direction:
                                          type: string
                                          nullable: true
                                        order:
                                          type: string
                                          nullable: true
                                    - type: array
                                      items:
                                        nullable: true
                                    - nullable: true
                                order:
                                  type: string
                                  nullable: true
                            - type: array
                              items:
                                nullable: true
                            - nullable: true
                        type:
                          type: string
                          nullable: true
                        users:
                          type: array
                          items:
                            anyOf:
                              - type: object
                                properties:
                                  id:
                                    type: number
                                    nullable: true
                              - type: array
                                items:
                                  nullable: true
                              - nullable: true
                        usersCount:
                          type: number
                          nullable: true
                  page:
                    type: object
                    properties:
                      cursor:
                        type: string
                        nullable: true
                        default: null
                        description: >-
                          The cursor for this page. Pass it as `cursor` to get
                          the same page again.
                      nextCursor:
                        type: string
                        nullable: true
                      hasMore:
                        type: boolean
                    required:
                      - nextCursor
                      - hasMore
                    additionalProperties: false
                required:
                  - items
                  - page
                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.