List contacts

curl --request GET \
  --url https://your-instance.example.com/api/contacts \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "contacts": [],
    "total": 0,
    "page": 1,
    "size": 50
  }
}

GET

api

contacts

List contacts

curl --request GET \
  --url https://your-instance.example.com/api/contacts \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": {
    "contacts": [],
    "total": 0,
    "page": 1,
    "size": 50
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

default:1

Required range: x >= 1

size

integer

default:50

Required range: x >= 1

string

default:""

source

string

leadSource

string

ownerFilter

string

default:my

status

string

pipelineStage

string

pipelineId

string

dateRange

string

JSON string range

owner

assignee

messageStatus

string

lastMessageTimeRange

string

JSON string range

lastMessageDateRange

string

JSON string range

Response

Contacts returned

success

enum<boolean>

required

Available options:

true

data

object

required

Show child attributes