List a campaign's contacts

GET /v1/campaigns/{campaign_id}/contacts

Each person in the campaign and how it went: waiting, being called, done, given up on after every try, or not called at all and why — with the last conversation, your own metadata and external_id. In the order they were added. Filter by status. Needs campaigns:read.

Parameters

Name	In	Type	Required	Description
`campaign_id`	path	string (uuid)	Yes
`status`	query	CampaignContactStatus or null	No	Only contacts in this state.
`limit`	query	integer	No	How many to return, 1 to 100.
`cursor`	query	string or null	No	`next_cursor` from the previous page, with the same filters.

Answer

200 with CampaignContactList.

Errors

Every error is a problem document with a stable code.

Status	When
`401`	The key is missing, mistyped, unknown, revoked or expired.
`403`	The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
`404`	This key reaches no such campaign.
`422`	Validation Error
`429`	Too many requests for this key or its organization; see `Retry-After`.
`500`	Something went wrong on our side. Quote the `request_id` to support.

Examples

See how each call in a campaign went

#!/bin/sh
# See how each call in a campaign went
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/campaigns/1c3e5a7b-9d0f-4b2c-8e4a-6c8e0a2c4e6b/contacts?status=done" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.