Skip to main content
GET
/
public-api
/
campaigns
Retrieve a paginated list of campaigns with their steps
curl --request GET \
  --url https://agents.nineteen58.co.za/public-api/campaigns \
  --header 'x-api-key: <api-key>'
{
  "campaigns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "active": true,
      "steps": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "step_number": 123
        }
      ]
    }
  ],
  "totalCount": 123,
  "currentPage": 123,
  "pageSize": 123,
  "totalPages": 123
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-api-key
string
required

API key for authentication

Query Parameters

​
page
integer
default:1

Page number for pagination

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

Number of items per page

Required range: 1 <= x <= 100
​
name
string

Filter campaigns by partial name match (case-insensitive)

​
active
boolean

Filter campaigns by active status

​
includeSteps
boolean
default:true

Whether to include campaign steps in the response

Response

Successfully retrieved campaigns

​
campaigns
object[]
​
totalCount
integer
​
currentPage
integer
​
pageSize
integer
​
totalPages
integer