GET
/
campaigns
/
{id}
/
contacts
cURL
curl --request GET \
  --url https://api.altur.io/api/v1.0/campaigns/{id}/contacts \
  --header 'Authorization: <api-key>'
{
  "total_count": 123,
  "contacts": [
    {
      "f_id": "<string>",
      "id": 123,
      "name": "<string>",
      "contact": "<string>",
      "status": "<string>",
      "context": "<string>",
      "failed_retries": 123,
      "voicemail_retries": 123,
      "tags": [
        "<string>"
      ],
      "extracted_data": {}
    }
  ],
  "pagination": {
    "has_more": true,
    "has_previous": true,
    "next_cursor": "<string>",
    "previous_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Path Parameters

id
integer
required

The identifier of the Campaign to return the Contacts

Query Parameters

status
enum<string>

Filters the Campaign Contacts by Status of the Campaign Contact

Available options:
queue,
sending,
sent,
delivered,
voicemail,
read,
failed,
no-answer,
busy,
retrying,
converted,
acepted,
rejected,
unreachable
pageSize
integer
default:25

Number of items per page to return.

Required range: x <= 100
cursor
string

Cursor to the next page to return.

direction
enum<string>
default:next

Direction of the cursor to return the results in.

Available options:
next,
previous

Response

Campaign Contacts response

total_count
integer

Total number of Campaign Contacts for the given query

contacts
object[]
pagination
object