Skip to main content
POST
List active contacts for user context

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