List campaigns

GET/v1/campaigns

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

statusstring

limitinteger<int32>

min 1 · max 100 · default: 20

offsetinteger<int32>

min 0 · default: 0

Responses

200OK

itemsCampaignItem[] | nullrequired

Show properties

Array of CampaignItem

audience_source_idstring

audience_source_typestringrequired

canceled_atstring

completed_atstring

created_atstringrequired

descriptionstring

explicit_contact_idsstring[] | null

failed_atstring

idstringrequired

metadataany

namestringrequired

organization_idstringrequired

scheduled_atstring

started_atstring

statusstringrequired

updated_atstringrequired

metaPaginationMetarequired

Show properties

cursorstring

has_morebooleanrequired

limitinteger<int64>required

next_cursorstring

offsetinteger<int64>

totalinteger<int64>

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/campaigns"

const response = await fetch("/v1/campaigns", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/campaigns",
)

Response

{
  "items": [
    {
      "audience_source_id": "string",
      "audience_source_type": "string",
      "canceled_at": "string",
      "completed_at": "string",
      "created_at": "string",
      "description": "string",
      "explicit_contact_ids": [
        "string"
      ],
      "failed_at": "string",
      "id": "string",
      "metadata": "string",
      "name": "string",
      "organization_id": "string",
      "scheduled_at": "string",
      "started_at": "string",
      "status": "string",
      "updated_at": "string"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}