List campaigns

Your campaigns, newest first.

Permission: Any key (Full, Send only or Read only).

GET /v1/campaigns

List campaigns

cURL

curl --request GET \
  --url https://api.getreply.in/v1/campaigns \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "source": "api",
      "template": {},
      "category": "<string>",
      "reference": "<string>",
      "people": 123,
      "counts": {
        "sent": 123,
        "delivered": 123,
        "read": 123,
        "failed": 123,
        "skipped": 123
      },
      "spent": "<string>",
      "currency": "<string>",
      "scheduled_at": "<string>",
      "created_at": "<string>",
      "started_at": "<string>",
      "finished_at": "<string>",
      "stopped_at": "<string>"
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123
}

Authorizations

Authorization · string · header · required

Your API key, e.g. gr_live_…

Query Parameters

status · string

draft, scheduled, sending, paused, completed, stopped or failed.

page · integer · default: 1

Page number, from 1.

Required range: x >= 1

per_page · integer · default: 50

How many on a page (at most 100).

Required range: 1 <= x <= 100

Response

200

application/json

A page of campaigns.

data · object[] · required

Show child attributes

page · integer

per_page · integer

total · integer