Skip to main content
GET
/
campaigns
/
{campaignId}
/
contacts
/
{contactId}
Get a contact by ID.
curl --request GET \
  --url https://api.callers.ai/campaigns/{campaignId}/contacts/{contactId} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "phoneNumber": "<string>",
  "campaignId": "<string>",
  "status": "<string>",
  "attempts": 123,
  "createdAt": "<string>",
  "lastAttempt": "<string>",
  "failedReason": "<string>",
  "failedReasonDetails": "<string>"
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

​
campaignId
string
required

Id of the campaign as a string ObjectId value.

​
contactId
string
required

Id of the contact as a string ObjectId value.

Response

default - application/json
​
id
string
required

The id of the contact. string representation of a ObjectId.

​
name
string
required

The name of the contact.

​
phoneNumber
string
required

The phone number of the contact.

​
campaignId
string
required

The id of the campaign. string representation of a ObjectId.

​
status
string
required

The status of the contact.

​
attempts
number
required

The total number of call attempts made to reach the contact.

​
createdAt
string
required

The date and time the contact was created in ISO format.

​
lastAttempt
string
required

The date and time of the last call attempt in ISO format.

​
failedReason
string

The reason for failing the call.

​
failedReasonDetails
string

The reason details for failing the call.