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

> ## Agent Instructions
> You are reading OnlyX Help: the OnlyX Help Center and the OnlyX developer documentation. OnlyX is an AI chatting and CRM platform for OnlyFans agencies. Its AI chatter is called Hugo in the app.
> Pages at the site root (for example /inbox/..., /hugo/..., /billing/...) are Help Center articles for agency owners, admins, chatters and creators who use the app at app.onlyx.ai. Words in bold are the exact button, menu and label names the app shows; keep them exactly as written. When these pages do not answer a question, the person can email support at support@onlyx.ai.
> Pages under /developers are the developer documentation. REST API base URL: https://api.onlyx.ai/v1 (authenticate with `Authorization: Bearer <API key>`; keys start with onx_sk_ and are created in app.onlyx.ai under Settings > API & MCP). MCP server: https://mcp.onlyx.ai/mcp (OAuth, or a Bearer API key). In the API the AI chatter is `ai` on the wire. Money is integer US cents in fields ending in Cents; timestamps are UTC ISO-8601.
> Rules for assistants acting on a user's behalf: discover ids with list calls and never invent them; before any call that reaches a real fan or the live OnlyFans account (sending a message, releasing a chat to the AI, turning AI on for a chat, resolving a hand-off, turning review mode off, changing the welcome message, creating a tracking link) show the user the exact content and get explicit confirmation; send every POST with an Idempotency-Key and reuse it on retry; never resend a message whose delivery status is unconfirmed; never ask a creator for her OnlyFans password or codes - she signs in herself through a connect link and the OnlyX Login app.

# List tracking links

> Lists the creator's OnlyFans tracking and trial links, most clicks first, with clicks and subscribers from OnlyFans, your cost fields, and computed earnings, profit, ROI and per-click and per-fan figures (all money in cents; a figure that cannot be worked out is `null`, never `0`). OnlyX reads the links from OnlyFans about once an hour while she is connected, so there is no need to poll this more than every few minutes. Archived links are left out unless `includeArchived=true`. Page with `limit` (up to 100) and `cursor`.

**Scope:** requires `links:read`.

**Rate limit:** the general limit of 120 requests per 60 seconds per credential.



## OpenAPI

````yaml /developers/api-reference/openapi.json get /v1/creators/{creatorId}/tracking-links
openapi: 3.1.0
info:
  contact:
    email: developers@onlyx.ai
    name: OnlyX developers
    url: https://docs.onlyx.ai/
  description: >
    The OnlyX API runs your OnlyX workspace from your own code and AI tools:
    creators and their

    connection, the fan inbox, fans, vault media, statistics, the AI chatter's
    setup and tracking links.


    **Authentication.** Send an API key as `Authorization: Bearer onx_sk_…`
    (create one in OnlyX under

    Settings → API & MCP), or an OAuth access token issued to a connected app.
    Keys belong to the

    workspace, carry scopes, and can be limited to some creators.


    **Conventions.** JSON with camelCase fields; timestamps are ISO-8601 UTC
    with a `Z`; money is integer

    US cents (fields end in `Cents`). Lists return `{"data": [...], "hasMore":
    bool, "nextCursor": string|null}`

    and page with `limit` and `cursor`.


    **Scopes.** Every operation names the scope it needs in `x-required-scope`
    and in its description; a

    credential without it gets `403 INSUFFICIENT_SCOPE`.


    **Errors and limits.** Errors are `{"error": {"code", "message",
    "requestId"}}`; every response

    carries `X-Request-Id`. The default limit is 120 requests per 60 seconds per

    credential, reported in `X-RateLimit-*` headers; over it you get `429
    RATE_LIMITED` with `Retry-After`.

    Operations with limits of their own list them in `x-rate-limits`.


    **Idempotency and safety.** Every write accepts an `Idempotency-Key` header
    (required when sending a

    message, adding a creator and creating a tracking link): retry with the same
    key and you get the

    original answer instead of a second action. Operations marked
    `x-reaches-fans: true` can reach a real

    fan or change the live OnlyFans account.


    Guides, the MCP server and more: [docs.onlyx.ai](https://docs.onlyx.ai).
  summary: >-
    Run your OnlyX workspace (creators, inbox, fans, stats and the AI chatter)
    from code and AI tools.
  title: OnlyX API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.onlyx.ai
security:
  - bearerAuth: []
tags:
  - description: 'Who you are: the workspace and credential behind a key.'
    name: Workspace
  - description: >-
      The creators your workspace manages: list, read, add, rename, and the AI
      switch.
    name: Creators
  - description: >-
      Connecting a creator's OnlyFans account: connect links she opens on her
      own device, and the connection status to poll.
    name: Connect
  - description: >-
      The fan inbox: list and count conversations, read state, take over,
      release, and the per-chat AI switch.
    name: Conversations
  - description: Read message history and send text, free media and paid messages to fans.
    name: Messages
  - description: Conversations the AI chatter handed to your team, and resolving them.
    name: Hand-offs
  - description: >-
      Fans, their purchases, fan lists, and your team's notes, custom names and
      mute flag.
    name: Fans
  - description: >-
      Each creator's OnlyFans vault: media ids for messages and levels, and
      thumbnails.
    name: Media
  - description: >-
      Today, revenue, audience, the cached overview report, and each creator's
      transaction ledger.
    name: Stats
  - description: The brief the AI chatter follows to chat as each creator.
    name: AI persona
  - description: 'The AI content ladder: folders, ladders, priced levels and their media.'
    name: AI content
  - description: >-
      Follow-ups, review mode, the master AI switch, and OnlyFans' welcome
      message.
    name: AI settings
  - description: >-
      OnlyFans tracking and trial links, your cost fields, and creating new
      links.
    name: Tracking links
externalDocs:
  description: OnlyX developer documentation
  url: https://docs.onlyx.ai
paths:
  /v1/creators/{creatorId}/tracking-links:
    get:
      tags:
        - Tracking links
      summary: List tracking links
      description: >-
        Lists the creator's OnlyFans tracking and trial links, most clicks
        first, with clicks and subscribers from OnlyFans, your cost fields, and
        computed earnings, profit, ROI and per-click and per-fan figures (all
        money in cents; a figure that cannot be worked out is `null`, never
        `0`). OnlyX reads the links from OnlyFans about once an hour while she
        is connected, so there is no need to poll this more than every few
        minutes. Archived links are left out unless `includeArchived=true`. Page
        with `limit` (up to 100) and `cursor`.


        **Scope:** requires `links:read`.


        **Rate limit:** the general limit of 120 requests per 60 seconds per
        credential.
      operationId: listTrackingLinks
      parameters:
        - description: The creator id (`cre_…`).
          in: path
          name: creatorId
          required: true
          schema:
            description: The creator id (`cre_…`).
            title: Creatorid
            type: string
        - description: Include links you archived in OnlyX.
          in: query
          name: includeArchived
          required: false
          schema:
            default: false
            description: Include links you archived in OnlyX.
            title: Includearchived
            type: boolean
        - description: Page size, 1-100. Default 25.
          in: query
          name: limit
          required: false
          schema:
            default: 25
            description: Page size, 1-100. Default 25.
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
        - description: >-
            Opaque cursor from the previous page's `nextCursor`. Omit for the
            first page.
          in: query
          name: cursor
          required: false
          schema:
            anyOf:
              - maxLength: 1024
                type: string
              - type: 'null'
            description: >-
              Opaque cursor from the previous page's `nextCursor`. Omit for the
              first page.
            title: Cursor
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountedFans: 301
                    archived: false
                    arpuCents: 475
                    attributedFans: 388
                    claims: 0
                    claimsLimit: null
                    clicks: 4210
                    code: '17'
                    conversion: 0.0922
                    costCents: 25000
                    cpcCents: 6
                    cpfCents: 64
                    earningsCents: 184300
                    earningsKnown: true
                    epcCents: 44
                    expiresAt: null
                    firstSeenAt: '2026-09-01T10:14:00.000Z'
                    id: trk_5a7c9e1b3d5f7a9c1e3b
                    kind: tracking
                    lastSeenAt: '2026-09-26T09:15:00.000Z'
                    name: Reddit September
                    note: Paid posts in three subreddits
                    ofCreatedAt: '2026-09-01T10:00:00.000Z'
                    profitCents: 159300
                    roi: 6.372
                    source: reddit
                    subscribers: 388
                    trialDays: null
                    url: https://onlyfans.com/miarose/c17
                hasMore: true
                nextCursor: >-
                  eyJrIjoiY3JlYXRvcnMiLCJwIjp7ImkiOiJjcmVfOGYyYzFhOWIwZDdlNGMzZjJhMWIifX0.Yp3k0Qm7T2vX9aLc4R8sWg
              schema:
                $ref: '#/components/schemas/TrackingLinkPage'
          description: A page of tracking links, most clicks first.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '400':
          content:
            application/json:
              examples:
                VALIDATION_ERROR:
                  summary: VALIDATION_ERROR
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: 'limit: Input should be less than or equal to 100'
                      requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The request is not valid and was not carried out. Fix it before
            retrying. `VALIDATION_ERROR`: the request is not valid; `message`
            names the field and the problem.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          content:
            application/json:
              examples:
                INSUFFICIENT_SCOPE:
                  summary: INSUFFICIENT_SCOPE
                  value:
                    error:
                      code: INSUFFICIENT_SCOPE
                      message: This key does not have the `links:read` scope.
                      requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
                WORKSPACE_SUSPENDED:
                  summary: WORKSPACE_SUSPENDED
                  value:
                    error:
                      code: WORKSPACE_SUSPENDED
                      message: This workspace is suspended.
                      requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            The credential may not do this. `INSUFFICIENT_SCOPE`: the credential
            lacks the `links:read` scope (the `WWW-Authenticate` header names
            it; an OAuth token's message says "token" instead of "key").
            `WORKSPACE_SUSPENDED`: the workspace is suspended.
          headers:
            WWW-Authenticate:
              $ref: '#/components/headers/WWW-Authenticate'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '404':
          content:
            application/json:
              examples:
                CREATOR_NOT_FOUND:
                  summary: CREATOR_NOT_FOUND
                  value:
                    error:
                      code: CREATOR_NOT_FOUND
                      message: Creator not found.
                      requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
              schema:
                $ref: '#/components/schemas/Error'
          description: >-
            Not found. An id that does not exist, belongs to another workspace,
            or is outside this credential's creators all get the same answer.
            `CREATOR_NOT_FOUND`: no creator with this `creatorId` is visible to
            this credential.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    TrackingLinkPage:
      description: A page of tracking links.
      examples:
        - data:
            - accountedFans: 301
              archived: false
              arpuCents: 475
              attributedFans: 388
              claims: 0
              claimsLimit: null
              clicks: 4210
              code: '17'
              conversion: 0.0922
              costCents: 25000
              cpcCents: 6
              cpfCents: 64
              earningsCents: 184300
              earningsKnown: true
              epcCents: 44
              expiresAt: null
              firstSeenAt: '2026-09-01T10:14:00.000Z'
              id: trk_5a7c9e1b3d5f7a9c1e3b
              kind: tracking
              lastSeenAt: '2026-09-26T09:15:00.000Z'
              name: Reddit September
              note: Paid posts in three subreddits
              ofCreatedAt: '2026-09-01T10:00:00.000Z'
              profitCents: 159300
              roi: 6.372
              source: reddit
              subscribers: 388
              trialDays: null
              url: https://onlyfans.com/miarose/c17
          hasMore: true
          nextCursor: >-
            eyJrIjoiY3JlYXRvcnMiLCJwIjp7ImkiOiJjcmVfOGYyYzFhOWIwZDdlNGMzZjJhMWIifX0.Yp3k0Qm7T2vX9aLc4R8sWg
      properties:
        data:
          items:
            $ref: '#/components/schemas/TrackingLink'
          type: array
        hasMore:
          type: boolean
        nextCursor:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - data
        - hasMore
      title: TrackingLinkPage
      type: object
    Error:
      properties:
        error:
          properties:
            code:
              description: Stable, machine-readable error code.
              type: string
            message:
              description: What went wrong, in a sentence for a person.
              type: string
            requestId:
              description: >-
                The id of this request (also in the `X-Request-Id` header).
                Quote it to support.
              type: string
          required:
            - code
            - message
            - requestId
          type: object
      required:
        - error
      type: object
    TrackingLink:
      examples:
        - accountedFans: 301
          archived: false
          arpuCents: 475
          attributedFans: 388
          claims: 0
          claimsLimit: null
          clicks: 4210
          code: '17'
          conversion: 0.0922
          costCents: 25000
          cpcCents: 6
          cpfCents: 64
          earningsCents: 184300
          earningsKnown: true
          epcCents: 44
          expiresAt: null
          firstSeenAt: '2026-09-01T10:14:00.000Z'
          id: trk_5a7c9e1b3d5f7a9c1e3b
          kind: tracking
          lastSeenAt: '2026-09-26T09:15:00.000Z'
          name: Reddit September
          note: Paid posts in three subreddits
          ofCreatedAt: '2026-09-01T10:00:00.000Z'
          profitCents: 159300
          roi: 6.372
          source: reddit
          subscribers: 388
          trialDays: null
          url: https://onlyfans.com/miarose/c17
      properties:
        accountedFans:
          description: Of those, fans OnlyX could match to spend.
          type: integer
        archived:
          description: Hidden from the default list.
          type: boolean
        arpuCents:
          anyOf:
            - type: integer
            - type: 'null'
          description: Earnings per fan, in cents, or `null`.
        attributedFans:
          description: Fans OnlyFans attributes to this link.
          type: integer
        claims:
          description: 'Trial links: trials claimed.'
          type: integer
        claimsLimit:
          anyOf:
            - type: integer
            - type: 'null'
          description: 'Trial links: the most trials it gives, or `null` for no limit.'
        clicks:
          description: Clicks, as counted by OnlyFans.
          type: integer
        code:
          anyOf:
            - type: string
            - type: 'null'
          description: The link code on OnlyFans.
        conversion:
          anyOf:
            - type: number
            - type: 'null'
          description: '`subscribers / clicks`, or `null`.'
        costCents:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            What you paid for the promotion, in cents. `null` = never costed,
            `0` = free.
        cpcCents:
          anyOf:
            - type: integer
            - type: 'null'
          description: Cost per click, in cents, or `null`.
        cpfCents:
          anyOf:
            - type: integer
            - type: 'null'
          description: Cost per fan (subscriber), in cents, or `null`.
        earningsCents:
          anyOf:
            - type: integer
            - type: 'null'
          description: >-
            Lifetime spend of the fans this link brought, in cents. A floor when
            `accountedFans` is below `attributedFans`. `null` when no attributed
            fan is known. Never add link earnings up into creator revenue: a fan
            on two links counts on both.
        earningsKnown:
          description: '`false` until earnings could be worked out.'
          type: boolean
        epcCents:
          anyOf:
            - type: integer
            - type: 'null'
          description: Earnings per click, in cents, or `null`.
        expiresAt:
          anyOf:
            - type: string
            - type: 'null'
          description: When the link stops working, or `null`.
        firstSeenAt:
          anyOf:
            - type: string
            - type: 'null'
          description: When OnlyX first read the link.
        id:
          description: The tracking link id (`trk_…`).
          type: string
        kind:
          description: '`tracking`: a campaign link. `trial`: a free-trial link.'
          enum:
            - tracking
            - trial
          type: string
        lastSeenAt:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            When OnlyX last read it (about hourly while the creator is
            connected).
        name:
          anyOf:
            - type: string
            - type: 'null'
          description: The link name on OnlyFans.
        note:
          anyOf:
            - type: string
            - type: 'null'
          description: Your note.
        ofCreatedAt:
          anyOf:
            - type: string
            - type: 'null'
          description: When it was created on OnlyFans.
        profitCents:
          anyOf:
            - type: integer
            - type: 'null'
          description: '`earnings − cost`, in cents, or `null`.'
        roi:
          anyOf:
            - type: number
            - type: 'null'
          description: '`profit / cost`, or `null` when there is no cost.'
        source:
          anyOf:
            - type: string
            - type: 'null'
          description: Where you ran it (your label).
        subscribers:
          description: Subscribers it brought, as counted by OnlyFans.
          type: integer
        trialDays:
          anyOf:
            - type: integer
            - type: 'null'
          description: 'Trial links: the length of the free trial in days.'
        url:
          anyOf:
            - type: string
            - type: 'null'
          description: The public link to share.
      required:
        - id
        - kind
        - name
        - code
        - url
        - clicks
        - subscribers
        - claims
        - claimsLimit
        - trialDays
        - expiresAt
        - ofCreatedAt
        - costCents
        - source
        - note
        - archived
        - earningsCents
        - earningsKnown
        - attributedFans
        - accountedFans
        - conversion
        - profitCents
        - roi
        - cpcCents
        - epcCents
        - cpfCents
        - arpuCents
        - firstSeenAt
        - lastSeenAt
      title: TrackingLink
      type: object
  headers:
    X-RateLimit-Limit:
      description: >-
        Requests allowed in the current window of the tightest limit this
        request counted against.
      example: 120
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in that window.
      example: 117
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When that window resets, as Unix epoch seconds.
      example: 1790431380
      schema:
        type: integer
    X-Request-Id:
      description: >-
        The id of this request. Your own `X-Request-Id` (8 to 64 letters, digits
        or `-`) is echoed back; otherwise OnlyX creates one. Also in every error
        body as `requestId`: quote it to support.
      example: req-3f9a1c2b7d4e5f60a1b2c3d4
      schema:
        type: string
    WWW-Authenticate:
      description: >-
        The authentication challenge (RFC 6750), for example `Bearer
        error="insufficient_scope", scope="messages:send"`.
      schema:
        type: string
    Retry-After:
      description: Seconds to wait before trying again.
      example: 12
      schema:
        type: integer
  responses:
    Unauthorized:
      content:
        application/json:
          examples:
            INVALID_API_KEY:
              summary: INVALID_API_KEY
              value:
                error:
                  code: INVALID_API_KEY
                  message: The API key is invalid, expired or revoked.
                  requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
            INVALID_TOKEN:
              summary: INVALID_TOKEN
              value:
                error:
                  code: INVALID_TOKEN
                  message: The access token is invalid, expired or revoked.
                  requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
            UNAUTHORIZED:
              summary: UNAUTHORIZED
              value:
                error:
                  code: UNAUTHORIZED
                  message: >-
                    Authentication required. Send your API key as
                    `Authorization: Bearer onx_sk_…`.
                  requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        No credential was sent (`UNAUTHORIZED`), or it is invalid, expired or
        revoked (`INVALID_API_KEY` for API keys, `INVALID_TOKEN` for OAuth
        access tokens: refresh the token or reconnect the app). Too many failed
        attempts from one address with credentials OnlyX never issued are
        answered `429 RATE_LIMITED` instead.
      headers:
        WWW-Authenticate:
          $ref: '#/components/headers/WWW-Authenticate'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    RateLimited:
      content:
        application/json:
          examples:
            RATE_LIMITED:
              summary: RATE_LIMITED
              value:
                error:
                  code: RATE_LIMITED
                  message: Too many requests. Try again in 12 seconds.
                  requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        Over a rate limit (`RATE_LIMITED`). Wait `Retry-After` seconds, then
        retry — with the same `Idempotency-Key` for a write.
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    InternalError:
      content:
        application/json:
          examples:
            INTERNAL_ERROR:
              summary: INTERNAL_ERROR
              value:
                error:
                  code: INTERNAL_ERROR
                  message: Something went wrong on our side.
                  requestId: req-3f9a1c2b7d4e5f60a1b2c3d4
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        Something went wrong on OnlyX's side (`INTERNAL_ERROR`). Retry with
        backoff (reuse the `Idempotency-Key` for a write); quote `requestId` to
        support if it persists.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
  securitySchemes:
    bearerAuth:
      bearerFormat: onx_sk_… API key or onx_at_… access token
      description: >-
        An API key (`onx_sk_…`) created in OnlyX under Settings → API & MCP, or
        an OAuth access token (`onx_at_…`) issued to a connected app. Send it as
        `Authorization: Bearer <credential>`. API keys may also be sent as
        `X-API-Key: <key>`.
      scheme: bearer
      type: http

````