Skip to main content
GET
Get inactive contacts phone/email list

Authorizations

Authorization
string
header
required

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

Query Parameters

channelType
enum<string>
Available options:
sms,
email
includeExisting
enum<string>

When truthy, include contacts that already have an existing conversation in the requested channel. Returned items will carry an "existingConversationId" field for those contacts.

Available options:
true,
1

Response

Inactive contacts returned

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