Skip to main content
POST
/
api
/
contacts
/
status
Get contacts for one status
curl --request POST \
  --url https://your-instance.example.com/api/contacts/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "New Lead",
  "pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1",
  "page": 1,
  "size": 50,
  "ownerFilter": "all"
}
'
{
  "data": [],
  "total": 0,
  "status": "New Lead",
  "pipelineStage": "64f0a1b2c3d4e5f6a7b8c9d2"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
status
string
required

Stage to query, identified by stage name or stage _id.

​
pipelineId
string

Pipeline _id to query; falls back to the org's active Contact pipeline when omitted.

​
page
integer

1-based page number for the requested stage.

​
size
integer

Page size (default 50).

​
search
string

Case-insensitive substring match across name and phone number.

​
showUnreadOnly
boolean

Restrict to contacts whose isUpdated flag is set.

​
ownerFilter
string

Quick-tab owner scope: my, all, team, unassigned, or a specific user _id.

​
bulkOnly
boolean

Restrict to contacts created via bulk import.

​
showUnresolvedOnly
boolean

Restrict to contacts with at least one webchat conversation in a pending/unresolved state.

Response

Contacts returned

​
data
object[]
​
total
integer
​
status
string
​
pipelineStage
string
​
stageIdByName
object
​
stageNameById
object