Skip to main content
POST
/
api
/
contacts
/
statuses
Get contacts across all statuses
curl --request POST \
  --url https://your-instance.example.com/api/contacts/statuses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "size": 123,
  "search": "<string>",
  "pages": {},
  "pipelineId": "<string>",
  "showUnreadOnly": true,
  "channelType": "<string>",
  "source": "<string>",
  "ownerFilter": "<string>",
  "bulkOnly": true,
  "showUnresolvedOnly": true
}
'
{
  "data": {},
  "dataByStatus": {},
  "stageIdByName": {},
  "stageNameById": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
size
integer
pages
object
pipelineId
string
showUnreadOnly
boolean
channelType
string
source
string
ownerFilter
string
bulkOnly
boolean
showUnresolvedOnly
boolean

Response

Contacts grouped by statuses

data
object
dataByStatus
object
stageIdByName
object
stageNameById
object