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

# List users for a tracking link

> List users associated with a tracking link owned by the authenticated user.

<Info>
  **Required scope**

  * `read:tracking_links` — Read tracking links and the users associated with them, including per-user tracking metadata.
</Info>


## OpenAPI

````yaml /openapi.json get /tracking-links/{uuid}/users
openapi: 3.1.0
info:
  title: Fanvue API
  version: '0.1'
servers: []
security: []
paths:
  /tracking-links/{uuid}/users:
    get:
      summary: List users for a tracking link
      description: >-
        List users associated with a tracking link owned by the authenticated
        user.
      operationId: listTrackingLinkUsers
      parameters:
        - $ref: '#/components/parameters/ApiVersionHeader'
        - schema:
            type: string
            format: uuid
            description: Tracking link UUID
          required: true
          description: Tracking link UUID
          name: uuid
          in: path
        - schema:
            type: integer
            exclusiveMinimum: 0
            description: Number of results to return (default 20)
          required: false
          description: Number of results to return (default 20)
          name: limit
          in: query
        - schema:
            type: string
            description: Cursor for pagination
          required: false
          description: Cursor for pagination
          name: cursor
          in: query
      responses:
        '200':
          description: List of users associated with the tracking link
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        uuid:
                          type: string
                          format: uuid
                        handle:
                          type: string
                        displayName:
                          type: string
                        nickname:
                          type:
                            - string
                            - 'null'
                        isTopSpender:
                          type: boolean
                        avatarUrl:
                          type:
                            - string
                            - 'null'
                        registeredAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            When the user converted (subscribed to or followed
                            the creator) via this tracking link — the conversion
                            attributed to the link. Reflects the relationship
                            matching the user's current status, and is null when
                            there is no current relationship or when the
                            relationship pre-dates the user's first click on
                            this link (so it was not driven by it). For the raw
                            relationship dates regardless of attribution, see
                            subscribedAt / followedAt.
                        subscribedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            When the user subscribed to the creator, regardless
                            of whether the subscription is attributed to this
                            link. Null if the user has no subscription to the
                            creator.
                        followedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: >-
                            When the user followed the creator, regardless of
                            whether the follow is attributed to this link. Null
                            if the user does not follow the creator.
                        clickedAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          description: When the user first clicked this tracking link.
                        status:
                          type:
                            - string
                            - 'null'
                          enum:
                            - subscriber
                            - follower
                            - expired
                            - deleted
                          description: >-
                            User's relationship status with the creator:
                            subscriber (active subscription), follower
                            (following only), expired (subscription ended),
                            deleted (user soft-deleted), or null (registered via
                            link but no current relationship)
                      required:
                        - uuid
                        - handle
                        - displayName
                        - nickname
                        - isTopSpender
                        - avatarUrl
                        - registeredAt
                        - subscribedAt
                        - followedAt
                        - clickedAt
                        - status
                    description: Users associated with this tracking link
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: Cursor for next page
                required:
                  - data
                  - nextCursor
              example:
                data:
                  - uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479
                    handle: sarah-jones
                    displayName: Sarah Jones
                    nickname: SarahK
                    isTopSpender: true
                    avatarUrl: https://media.fanvue.com/avatars/fan-a.jpg
                    registeredAt: '2024-01-15T00:00:00.000Z'
                    subscribedAt: '2024-01-15T00:00:00.000Z'
                    followedAt: null
                    clickedAt: '2024-01-14T00:00:00.000Z'
                    status: subscriber
                  - uuid: 6ba7b810-9dad-11d1-80b4-00c04fd430c8
                    handle: mike-smith
                    displayName: Mike Smithly
                    nickname: null
                    isTopSpender: false
                    avatarUrl: null
                    registeredAt: '2024-01-14T00:00:00.000Z'
                    subscribedAt: null
                    followedAt: '2024-01-14T00:00:00.000Z'
                    clickedAt: '2024-01-14T00:00:00.000Z'
                    status: follower
                nextCursor: '456'
        '400':
          description: >-
            Bad Request - API version not supported OR validation failed OR
            invalid UUID
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/UnsupportedVersionError'
                  - $ref: '#/components/schemas/ValidationError'
                  - $ref: '#/components/schemas/InvalidUuidError'
        '401':
          $ref: '#/components/responses/UnauthorizedResponse'
        '403':
          $ref: '#/components/responses/UnauthorizedResponse'
        '404':
          $ref: '#/components/responses/NotFoundResponse'
        '410':
          $ref: '#/components/responses/SunsetVersionResponse'
        '429':
          $ref: '#/components/responses/RateLimitResponse'
      security:
        - BearerAuth:
            - read:tracking_links
components:
  parameters:
    ApiVersionHeader:
      name: X-Fanvue-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2025-06-26'
        example: '2025-06-26'
      description: API version to use for the request
  schemas:
    UnsupportedVersionError:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
      required:
        - error
        - message
      description: API version not supported
    ValidationError:
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
      required:
        - errors
      description: Request validation failed
    InvalidUuidError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      description: Invalid UUID format provided
  responses:
    UnauthorizedResponse:
      description: Unauthorized Response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
    NotFoundResponse:
      description: Not Found Response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message
    SunsetVersionResponse:
      description: API version no longer supported (sunset)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              message:
                type: string
              nextVersion:
                type: string
            required:
              - error
              - message
    RateLimitResponse:
      description: Too many requests - rate limit exceeded
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying the request
          schema:
            type: integer
        X-RateLimit-Limit:
          description: The maximum number of requests allowed in the current window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: The number of requests remaining in the current window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: The Unix timestamp (seconds) when the rate limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
            required:
              - error
  securitySchemes:
    BearerAuth:
      type: oauth2
      description: >-
        OAuth 2.0 access token, presented as a JWT bearer token in the
        `Authorization` header. Obtain a token via the authorization-code flow;
        the scopes granted to the token determine which operations it may call.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.fanvue.com/oauth2/auth
          tokenUrl: https://auth.fanvue.com/oauth2/token
          refreshUrl: https://auth.fanvue.com/oauth2/token
          scopes:
            read:self: >-
              Access your own user profile information, including basic account
              details and settings.
            read:chat: >-
              Read chat conversations, messages, and chat-related data. This
              includes viewing chat lists and message history.
            write:chat: >-
              Create new chats and send messages. This scope is required for any
              chat-related actions that modify data.
            read:experience: >-
              Exchange a fan's experience token for the resolved experience and
              the fan's identity, so an embedded fan-facing experience can
              render the right content.
            write:experience: >-
              Request that the creator publish or unpublish a fan-facing
              experience. The app mints a request token; the creator confirms
              and Fanvue performs the change.
            read:fan: Access fan-related data and information within the platform.
            read:post: Read posts, including post details, comments, likes, and tips.
            write:post: Create, edit, and manage posts and content on behalf of users.
            read:media: Access media files, images, videos, and other content assets.
            write:media: >-
              Upload, modify, and manage media files and content assets. Also
              required for vault folder management.
            read:creator: >-
              Access creator profiles, content, and creator-specific
              information.
            write:creator: Modify creator profiles, settings, and creator-specific data.
            read:insights: >-
              Access analytics, metrics, and insights data for performance
              tracking.
            read:tracking_links: >-
              Read tracking links and the users associated with them, including
              per-user tracking metadata.
            write:tracking_links: Create and delete tracking links.
            read:agency: Read agency information, including the agency's team members.
            write:agency: >-
              Manage agency team members and invites, including inviting new
              team members and creators.

````