Campaign
Read Campaign Contact List
Endpoints
- Calling
- Messaging
- Conversation
- Contact
- Assistant
- Widget
- Data Source
- User
- Intent
- Prompt
- Voice
- Tool
- Form
- Channel
- Campaign
- Outbound Webhook
- Custom Field
- Provider
- Agency
- Tool Function
- Agency Billing
- Log
- Conversation Flow
- Analytics
- Tag
- Billing
- API Reference
Campaign
Read Campaign Contact List
Retrieve contacts
GET
/
api
/
v1
/
campaign_contact
/
list
/
{campaign_id}
{
"message": "<string>",
"meta": {},
"data": {
"items": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"channels": {},
"user_attributes": {},
"last_seen": "2023-11-07T05:31:56Z",
"last_sent": "2023-11-07T05:31:56Z",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_fields": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_attributes": {},
"status": "not_attempted",
"execution_time": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"page": 2,
"size": 2,
"pages": 1,
"previous_page": 123,
"next_page": 123
}
}
Authorizations
Your API key for authentication. You can generate it from the Settings page. Format: starts with in-
.
Path Parameters
Query Parameters
Required range:
x >= 1
Required range:
1 <= x <= 100
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
{
"message": "<string>",
"meta": {},
"data": {
"items": [
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"channels": {},
"user_attributes": {},
"last_seen": "2023-11-07T05:31:56Z",
"last_sent": "2023-11-07T05:31:56Z",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"custom_fields": {},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"campaign_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_attributes": {},
"status": "not_attempted",
"execution_time": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"page": 2,
"size": 2,
"pages": 1,
"previous_page": 123,
"next_page": 123
}
}