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,
    "type": "<string>",
    "canClaim": true,
    "claimsCount": 123,
    "subscribeCounts": 123,
    "subscribeDays": 123,
    "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

Response

Successful response

​
id
number
required
​
message
string
required
​
rawMessage
string
required
​
hasRelatedPromo
boolean
required
​
price
number
required
​
type
string
required
​
canClaim
boolean
required
​
claimsCount
number
required
​
subscribeCounts
number
required
​
subscribeDays
number
required
​
createdAt
string
required
​
finishedAt
string
required
​
isFinished
boolean
required