Skip to main content
GET
/
api
/
public
/
analytics
/
contacts
/
by-status
Get contacts by status
curl --request GET \
  --url https://api.example.com/api/public/analytics/contacts/by-status \
  --header 'x-api-key: <x-api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Headers

​
x-api-key
string
required

API key

Query Parameters

​
page
string
required

Page number

Example:

"1"

​
orderBy
enum<string>
Available options:
contact_created_at,
ticket_created_at,
last_inbound_message,
last_outbound_message,
id
​
channel
enum<string>
required
Available options:
whatsapp,
playground,
instagram,
webchat,
web-whatsapp,
messenger,
sms
​
pipelineId
string
required

Pipeline ID

Example:

"1234567890"

​
status
enum<string>
required

Status

Available options:
unattended,
attended,
ai-attended,
ai-away

Response

200 - application/json

Returns contacts with pending responses

​
id
string

Contact ID

​
name
string

Contact name

​
created_at
string<date-time>

Contact creation date