Skip to main content
GET
/
api
/
v1
/
campaigns
Get Campaigns List
curl --request GET \
  --url https://api.kollie.ai/api/v1/campaigns \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "items": [
      {
        "name": "<string>",
        "end_date": "2023-11-07T05:31:56Z",
        "start_time": "<string>",
        "end_time": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "draft",
        "start_date": "2023-11-07T05:31:56Z",
        "phone_numbers": [],
        "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "additional_params": {}
      }
    ],
    "page": 2,
    "size": 2,
    "total": 1,
    "pages": 1,
    "previous_page": 123,
    "next_page": 123
  },
  "message": "",
  "meta": {}
}

Authorizations

X-API-Key
string
header
required

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

data
PageBase[ICampaignRead] · object
required
message
string | null
default:""
meta
Meta · object