Get Contacts in a List
Get a list of contacts in a specific list
curl --request GET \
--url https://my.cald.ai/client/api/v1/lists/{listId}/contacts \
--header 'Authorization: <api-key>'
{
"contacts": [
{
"phoneNumber": "<string>",
"prospectName": "<string>",
"email": "<string>",
"yourCustomVariable": "<string>"
}
]
}
Authorizations
Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0
Path Parameters
The list ID of the list
Response
The phone number of the individual or business you're calling. - For international numbers, include the country code without extra formatting (such as parentheses or dashes), for example, '+441234567890'. - For U.S. numbers, although formatting is allowed, it's advisable to remove any additional characters for consistency.
The prospectName is the default variable that is always present for all agents. It can be used in your agent scripts on the MyCald Dashboard by typing {prospectName}.
The email address of the contact, this is optional
Feel free to add more custom variables to the list, depending on the use case. Once configured in the agent page of the MyCald Dashboard, they will automatically become available in the API
curl --request GET \
--url https://my.cald.ai/client/api/v1/lists/{listId}/contacts \
--header 'Authorization: <api-key>'
{
"contacts": [
{
"phoneNumber": "<string>",
"prospectName": "<string>",
"email": "<string>",
"yourCustomVariable": "<string>"
}
]
}