API reference · Campaigns

List campaigns

List your SMS and email campaigns, newest first. Paginated.

GET/v1/campaigns

Bearer API key
Rate limit 300 / min
Returns 200 OK
Needs the SMS or Email permission · free

GET /v1/campaigns

curl https://api.talks.africa/v1/campaigns \
  -H "Authorization: Bearer $TALKS_KEY"

{
  "data": [
    {
      "id": "cmp_41xk",
      "name": "Friday deals",
      "status": "sending",
      "recipient_count": 12480
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 37
  }
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Parameters

pageintegeroptional
Page number. Default 1.
limitintegeroptional
Per page. Default 20.

Response fieldsResponse

data[]
Campaigns
meta
page, limit, total

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?