Skip to main content
POST
/
api
/
contacts
/
active
List active contacts for user context
curl --request POST \
  --url https://your-instance.example.com/api/contacts/active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channelType": "sms",
  "ownerFilter": "my",
  "page": 1,
  "size": 50
}
'
{
  "data": [],
  "total": 0
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
channelType
string

Restrict to contacts whose channelTypes includes this channel (e.g. sms, webchat, email, voice, facebook). Accepts JSON-array strings for multi-select.

​
ownerFilter
string

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

Response

Active contacts returned

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