Skip to main content
POST
/
v1
/
get-contacts-batch
Get Contacts Batch
curl --request POST \
  --url https://api.telli.com/v1/get-contacts-batch \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "contact_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'
[
  {
    "status": "success",
    "contact": {
      "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_contact_id": "<string>",
      "external_url": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone_number": "<string>",
      "email": "[email protected]",
      "salutation": "<string>",
      "contact_details": {},
      "created_at": "2023-11-07T05:31:56Z",
      "in_call_since": "2023-11-07T05:31:56Z",
      "reached_at": "2023-11-07T05:31:56Z",
      "call_attempts": 123,
      "next_call_at": "2023-11-07T05:31:56Z"
    },
    "error": "<string>",
    "contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
Authorization
string
header
required

API key must be provided as: Bearer <api_key>

Body

application/json
​
contact_ids
string<uuid>[]
required

Array of telli contact IDs to retrieve. Maximum 1000 contacts per request.

Response

List of contacts retrieved successfully

​
status
enum<string>

Status of the contact retrieval

Available options:
success,
error
​
contact
object
​
error
string

Error message (only present for failed retrievals)

​
contactId
string<uuid>

The contact ID that was attempted to be retrieved (only present for failed retrievals)

⌘I