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

> List subscribers associated with one subscription promotion.

**Required scope:** `subscribers:read`



## OpenAPI

````yaml /openapi/v3.json get /v3/access/subscribers/activity/promotions/:promotionId
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/subscribers/activity/promotions/:promotionId:
    get:
      tags:
        - Subscribers
      summary: Promotion subscribers
      description: |-
        List subscribers associated with one subscription promotion.

        **Required scope:** `subscribers:read`
      operationId: access.subscribers.activity.listByPromotion
      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
            nullable: true
            minLength: 1
          required: false
          name: promotionId
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 20
            default: 10
            description: 'Number of items to return (1-20, default: 10)'
          required: false
          description: 'Number of items to return (1-20, 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
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        name:
                          type: string
                        username:
                          type: string
                        displayName:
                          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
                        lastSeen:
                          type: string
                          nullable: true
                        subscription:
                          type: object
                          properties:
                            isActive:
                              type: boolean
                            isExpired:
                              type: boolean
                            subscribedAt:
                              type: string
                              nullable: true
                            expiresAt:
                              type: string
                              nullable: true
                            renewedAt:
                              type: string
                              nullable: true
                            price:
                              type: number
                              nullable: true
                            regularPrice:
                              type: number
                              nullable: true
                            discountPercent:
                              type: number
                              nullable: true
                            discountPeriod:
                              type: number
                              nullable: true
                            discountStartedAt:
                              type: string
                              nullable: true
                            discountFinishedAt:
                              type: string
                              nullable: true
                            history:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: number
                                  startDate:
                                    type: string
                                  expireDate:
                                    type: string
                                  price:
                                    type: number
                                  regularPrice:
                                    type: number
                                  discount:
                                    type: number
                                  type:
                                    type: string
                                  action:
                                    type: string
                                  isCurrent:
                                    type: boolean
                                required:
                                  - id
                                  - startDate
                                  - expireDate
                                  - price
                                  - regularPrice
                                  - discount
                                  - type
                                  - action
                                  - isCurrent
                          required:
                            - isActive
                            - isExpired
                            - subscribedAt
                            - expiresAt
                            - renewedAt
                            - price
                            - regularPrice
                            - discountPercent
                            - discountPeriod
                            - discountStartedAt
                            - discountFinishedAt
                            - history
                        spending:
                          type: object
                          properties:
                            total:
                              type: number
                              description: >-
                                Amount in US dollars, not cents. For example,
                                12.50 means $12.50.
                            tips:
                              type: number
                              description: >-
                                Amount in US dollars, not cents. For example,
                                12.50 means $12.50.
                            subscriptions:
                              type: number
                              description: >-
                                Amount in US dollars, not cents. For example,
                                12.50 means $12.50.
                            messages:
                              type: number
                              description: >-
                                Amount in US dollars, not cents. For example,
                                12.50 means $12.50.
                            posts:
                              type: number
                              description: >-
                                Amount in US dollars, not cents. For example,
                                12.50 means $12.50.
                            streams:
                              type: number
                              description: >-
                                Amount in US dollars, not cents. For example,
                                12.50 means $12.50.
                          required:
                            - total
                            - tips
                            - subscriptions
                            - messages
                            - posts
                            - streams
                        isRestricted:
                          type: boolean
                        isBlocked:
                          type: boolean
                        capabilities:
                          type: object
                          properties:
                            canRestrict:
                              type: boolean
                            canBlock:
                              type: boolean
                            canReport:
                              type: boolean
                            canUnsubscribe:
                              type: boolean
                            canReceiveMessages:
                              type: boolean
                            canSendTrial:
                              type: boolean
                          required:
                            - canRestrict
                            - canBlock
                            - canReport
                            - canUnsubscribe
                            - canReceiveMessages
                            - canSendTrial
                        lists:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                anyOf:
                                  - type: string
                                  - type: number
                              name:
                                type: string
                            required:
                              - id
                              - name
                      required:
                        - id
                        - name
                        - username
                        - displayName
                        - isVerified
                        - avatar
                        - avatarThumbs
                        - lastSeen
                        - subscription
                        - spending
                        - isRestricted
                        - isBlocked
                        - capabilities
                        - lists
                  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.