CAcarecycle
Campaigns

List Campaigns

List your campaigns, with customer counts for each one. Results come back one page at a time.

get/v2/campaigns

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/campaigns
  • Auth
    API key in header x-api-key

Query parameters

pagenumber

GET /v2/campaigns Parameter

perPagenumber

GET /v2/campaigns Parameter

includeReceptionist'true' | 'false'

Include the organization receptionist in configuration listings. Receptionists cannot be assigned sources.

sortBy'createdAt' | 'updatedAt' | 'name' | 'status' | 'startDate' | 'todayCalls'

Field to sort by

sortDirection'asc' | 'desc'

Sort direction

searchstring

Search query for filtering campaigns by name or description

status'draft' | 'active' | 'paused' | 'completed' | 'archived' | 'cancelled'

Filter campaigns by status

kind'voice_ai' | 'agent_first'

Filter by campaign kind. 'voice_ai' returns voice-AI campaigns (and legacy null-kind); 'agent_first' returns agent-first dialers/desks.

Response

GET /v2/campaigns Positive response

itemsTotalnumber required
currentPagenumber required
nextPagenumber nullable required
prevPagenumber nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.