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

> List user lists

**Permission Required:** `lists:read`



## OpenAPI

````yaml https://api.ofauth.com/openapi.json get /v2/access/users/lists
openapi: 3.1.0
info:
  title: OFAuth API
  version: 1.0.0
  description: >-
    OFAuth API including Account, Connections, Link, Access, Dynamic Rules,
    Vault+, and Realtime webhook contracts
  contact:
    email: support@ofauth.com
    url: https://ofauth.com/
servers:
  - url: https://api.ofauth.com
security:
  - ApiKey: []
tags:
  - name: Account
    description: Account management endpoints.
  - name: Connections
    description: Connection management endpoints.
  - name: Link
    description: Link authentication and session endpoints.
  - name: Access
    description: All Access related endpoints.
  - name: Analytics
    description: 'Access: charts, tops, and performance metrics.'
  - 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: authenticated account details and settings.'
  - name: Stories
    description: 'Access: stories listing and management.'
  - name: Subscriptions
    description: 'Access: subscription offers, discounts, and management.'
  - name: Realtime
    description: >-
      Realtime webhook delivery contracts, including relayed OnlyFans websocket
      events.
  - name: Dynamic Rules
    description: Dynamic signing rules operations.
  - name: Vault+
    description: Vault+ caching and management.
externalDocs:
  description: OFAuth Developer Documentation
  url: https://docs.ofauth.com
paths:
  /v2/access/users/lists:
    get:
      tags:
        - User Lists
      summary: List user lists
      description: |-
        List user lists

        **Permission Required:** `lists:read`
      parameters:
        - 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: integer
            nullable: true
            minimum: 0
            default: 0
            description: 'Number of items to skip (default: 0)'
          required: false
          description: 'Number of items to skip (default: 0)'
          name: offset
          in: query
        - schema:
            type: string
            maxLength: 100
            description: Search/filter text
          required: false
          description: Search/filter text
          name: query
          in: query
        - schema:
            type: string
            minLength: 1
            description: Only return lists related to this user
          required: false
          description: Only return lists related to this user
          name: related_user
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          anyOf:
                            - type: string
                            - type: number
                        type:
                          type: string
                        name:
                          type: string
                        usersCount:
                          type: number
                        postsCount:
                          type: number
                        order:
                          type: string
                        direction:
                          type: string
                        canUpdate:
                          type: boolean
                        canDelete:
                          type: boolean
                        canManageUsers:
                          type: boolean
                        canAddUsers:
                          type: boolean
                        canPinnedToFeed:
                          type: boolean
                        isPinnedToFeed:
                          type: boolean
                        canPinnedToChat:
                          type: boolean
                        isPinnedToChat:
                          type: boolean
                        sortList:
                          type: array
                          items:
                            type: object
                            properties:
                              order:
                                type: string
                              direction:
                                type: string
                            required:
                              - order
                              - direction
                        users:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: number
                              username:
                                type: string
                              name:
                                type: string
                              isVerified:
                                type: boolean
                              avatar:
                                type: string
                                nullable: true
                              avatarThumbs:
                                type: object
                                nullable: true
                                properties:
                                  c50:
                                    type: string
                                  c144:
                                    type: string
                                required:
                                  - c50
                                  - c144
                            required:
                              - id
                              - username
                              - name
                              - isVerified
                              - avatar
                      required:
                        - id
                        - type
                        - name
                        - sortList
                        - users
                  hasMore:
                    type: boolean
                  order:
                    type: string
                  sort:
                    type: string
                required:
                  - list
                  - hasMore
        '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: true
      security:
        - ApiKey: []
          ConnectionId: []
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      name: apiKey
      in: header
      description: >-
        Your OFAuth [API key](/quickstart#2-copy-your-api-key) for
        authenticating requests.
    ConnectionId:
      type: apiKey
      name: x-connection-id
      in: header
      description: >-
        Requires a [connection](/guides/connections) via the x-connection-id
        header.

````