Skip to main content
GET
/
v2
/
access
/
promotions
List promotions
curl --request GET \
  --url https://api.ofauth.com/v2/access/promotions \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
[
  {
    "id": 123,
    "message": "<string>",
    "rawMessage": "<string>",
    "hasRelatedPromo": true,
    "price": 123,
    "canClaim": true,
    "claimsCount": 1,
    "subscribeCounts": 1,
    "subscribeDays": 1,
    "createdAt": "<string>",
    "finishedAt": "<string>",
    "isFinished": true
  }
]

Authorizations

​
apiKey
string
header
required

Your OFAuth API key for authenticating requests.

​
x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Query Parameters

​
limit
integer
default:20

Number of items to return (1-100, default: 20)

Required range: 1 <= x <= 100
​
offset
integer | null
default:0

Number of items to skip (default: 0)

Required range: x >= 0
​
status
enum<string>
default:active

Which items to include

Available options:
active,
deleted,
all

Response

Successful response

​
id
integer
required

Promotion ID

​
message
string
required

Rendered promotion message

​
rawMessage
string
required

Original promotion message

​
hasRelatedPromo
boolean
required

True when OF created paired audience promotions from one request

​
price
number
required

Discounted subscription price in dollars

​
type
enum<string>
required

Promotion campaign audience returned by OnlyFans.

Available options:
all,
expired
​
canClaim
boolean
required

Whether the promotion can currently be claimed

​
claimsCount
integer
required

Number of claims so far

Required range: x >= 0
​
subscribeCounts
integer | null
required

Offer limit, or null for no limit

Required range: x >= 0
​
subscribeDays
integer
required

Accepted promotion duration in days. OF can return 0 for first-month discounts.

Required range: x >= 0
​
createdAt
string
required

Creation timestamp returned by OF

​
finishedAt
string | null
required

Finish timestamp, or null for promotions without an explicit end date

​
isFinished
boolean
required

Whether the promotion has ended