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

# Promotion offers

> List promotion offers and associated users.

**Required scope:** `promotions:read`



## OpenAPI

````yaml /openapi/v3.json get /v3/access/promotions/offers
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/promotions/offers:
    get:
      tags:
        - Promotions
      summary: Promotion offers
      description: |-
        List promotion offers and associated users.

        **Required scope:** `promotions:read`
      operationId: access.promotions.getOffers
      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: string
            enum:
              - asc
              - desc
          required: false
          name: sort
          in: query
        - schema:
            type: string
            enum:
              - create_date
              - expire_date
              - finish_date
              - is_finished
              - subscribe_days
          required: false
          name: field
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
          required: false
          name: durationMonths
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
              - '1'
              - '0'
          required: false
          name: isInactive
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
              - '1'
              - '0'
          required: false
          name: isOnline
          in: query
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
              - '1'
              - '0'
          required: false
          name: hasRecommenders
          in: query
        - schema:
            type: number
            nullable: true
            minimum: 0
          required: false
          name: tipAmount
          in: query
        - schema:
            type: number
            nullable: true
          required: false
          name: totalSpent
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  claimedOffersCount:
                    type: number
                  offers:
                    type: array
                    items:
                      type: object
                      properties:
                        createdAt:
                          type: string
                        expiredAt:
                          type: string
                        finishedAt:
                          type: string
                        id:
                          type: number
                        subscribeDays:
                          type: number
                        subscriberId:
                          type: string
                        userId:
                          type: string
                      additionalProperties: true
                      required:
                        - createdAt
                        - expiredAt
                        - finishedAt
                        - id
                        - subscribeDays
                        - subscriberId
                        - userId
                  unclaimedOffersCount:
                    type: number
                  users:
                    type: object
                    properties:
                      '506355167':
                        type: object
                        properties:
                          id:
                            type: number
                        additionalProperties: true
                        required:
                          - id
                      '515679424':
                        type: object
                        properties:
                          id:
                            type: number
                        additionalProperties: true
                        required:
                          - id
                      '562630475':
                        type: object
                        properties:
                          id:
                            type: number
                        additionalProperties: true
                        required:
                          - id
                    additionalProperties: true
                    required:
                      - '506355167'
                      - '515679424'
                      - '562630475'
                additionalProperties: true
                required:
                  - claimedOffersCount
                  - offers
                  - unclaimedOffersCount
                  - users
        '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.