Promotions
List Promotions
List all promotions for the account.
get/api/{account}/promotions
Query parameters
limitinteger
The number of promotions to return. Default 10
Example:10
The number of promotions to return. Default 10
offsetinteger
The offset used for pagination. Default 0
The offset used for pagination. Default 0
Response
Example response
{
"data": {
"hasMore": false,
"items": [
{
"id": 123,
"message": "Example promotion message",
"rawMessage": "Example promotion message",
"hasRelatedPromo": false,
"price": 0,
"type": "all",
"canClaim": true,
"claimsCount": 0,
"subscribeCounts": 10,
"subscribeDays": 7,
"createdAt": "2025-01-01T00:00:00+00:00",
"finishedAt": "2025-01-02T00:00:00+00:00",
"isFinished": false
}
]
},
"_meta": {
"_credits": {
"used": 1,
"balance": 999999823,
"note": "Always"
},
"_cache": {
"is_cached": false,
"note": "Cache disabled for this endpoint"
},
"_rate_limits": {
"limit_minute": 1000,
"limit_day": null,
"remaining_minute": 999,
"remaining_day": null,
"notice": "We have decided to remove our daily rate limits. Please remove any references to these in your integrations."
}
}
}