Skip to main content
GET
/
data
/
campaign
cURL
curl --request GET \
  --url https://api.belio.co.ke/data/campaign \
  --header 'Authorization: Bearer <token>'
{
  "desc": "OK",
  "result": {
    "page": 123,
    "pageSize": 123,
    "total": 123,
    "data": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "teamId": "<string>",
        "serviceId": "<string>",
        "status": "Active",
        "rules": {
          "frequency": {
            "type": "OneTime"
          },
          "allowedDenominations": [
            "10MB"
          ],
          "expiry": "2023-11-07T05:31:56Z"
        }
      }
    ]
  }
}
Refer to Authentication for information on how to obtain a bearer token. This endpoint requires the reward.campaign.list API client authorization scope to access the list of campaigns. You can set up scopes on the API Clients page.

​
Rate Limit

This endpoint is rate limited to 1 request per second.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

1-indexed page number

Required range: x >= 1
​
pageSize
integer
default:100

Max number of items per page

Required range: x >= 1

Response

Campaigns retrieved successfully

​
desc
string
Example:

"OK"

​
result
object