Skip to main content
GET
/
v1
/
campaigns
List all campaigns
curl --request GET \
  --url https://api4.kinbox.com.br/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "channelId": "<string>",
      "channelIds": [
        "<string>"
      ],
      "operatorId": "<string>",
      "operatorName": "<string>",
      "businessHoursId": "<string>",
      "channelType": "1",
      "leadType": "lead",
      "scheduledTo": "<string>",
      "nextScheduledTo": "<string>",
      "originalScheduledTo": "<string>",
      "finishedAtPrediction": "<string>",
      "leadsAssetUrl": "<string>",
      "message": "<string>",
      "textRaw": "<string>",
      "assetsUrls": [
        "<string>"
      ],
      "active": true,
      "shouldCreateConversation": false,
      "status": "processing",
      "chunksCount": 123,
      "leadsCount": 123,
      "secondsBetweenMessages": 123,
      "secondsBetweenChunks": 123,
      "trackAllChannels": true,
      "trackMaxHours": 96,
      "chunkSize": 123,
      "template": {},
      "progress": 123,
      "resultCounts": {
        "sent": 123,
        "received": 123,
        "read": 123,
        "answered": 123,
        "chunksExecuted": 123,
        "byChunkId": {}
      },
      "messagesProcessed": 123,
      "lastMessageProcessedAt": "2023-11-07T05:31:56Z",
      "healthCheckData": {
        "messagesProcessed": 123,
        "lastMessageProcessedAt": "2023-11-07T05:31:56Z",
        "healthCheckExecutions": 123,
        "jobId": "<string>",
        "chunkId": "<string>",
        "nextHealthCheckAt": "2023-11-07T05:31:56Z",
        "lastHealthCheckAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "nextCursor": {}
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100.

​
cursor
string

A cursor for use in pagination. The cursor is the id of the last object returned in the previous request.

Response

200 - application/json
​
data
object[]
required
​
nextCursor
object
required

Cursor for the next page. Null if there are no more results.