Skip to main content
POST
/
api
/
contacts
List contacts by pipeline status buckets
curl --request POST \
  --url https://your-instance.example.com/api/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": {},
  "size": 123,
  "search": "<string>",
  "source": "<string>",
  "ownerFilter": "<string>",
  "owner": [
    "<string>"
  ],
  "assignee": [
    "<string>"
  ],
  "pipelineType": "Contact",
  "pipelineId": "<string>",
  "status": "<string>",
  "dateRange": {},
  "createdDateRange": {},
  "customFilters": {},
  "stages": [
    "<string>"
  ],
  "stageIdByName": {},
  "bulkOnly": true,
  "messageStatus": "<string>",
  "lastMessageTimeRange": {},
  "lastMessageDateRange": {}
}
'
{
  "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
page
object
size
integer
source
string
ownerFilter
string
owner
string[]
assignee
string[]
pipelineType
enum<string>
Available options:
Contact,
Application
pipelineId
string
status
string
dateRange
object
createdDateRange
object
customFilters
object
stages
string[]
stageIdByName
object
bulkOnly
boolean
messageStatus
string
lastMessageTimeRange
object
lastMessageDateRange
object

Response

Contacts grouped by status

data
object
dataByStatus
object
stageIdByName
object
stageNameById
object