Admin/Get Contacts
App
GET /v1/admin/contacts

Get Contacts

Base URL https://api.{cluster}.{platform}.voiger.io
Request · cURL 
curl https://api.{cluster}.{platform}.voiger.io/v1/admin/contacts?_limit=&_skip= \
  -H "Cookie: sid=$VOIGER_SESSION" \
  -H "x-workspace-code: your-workspace-code"

Parameters

x-workspace-code string required in header
_limit number optional in query
_skip number optional in query
_search string optional in query
_sort string optional in query
archived string optional in query
Filters by archive state. Defaults to `"false"` (active contacts only). - `"false"` — only active contacts (default) - `"true"` — only archived contacts - `"include"` — both active and archived

Response

contacts▾
array
id
string
first_name
string
last_name
string
gender
string
access
string
country
string
field_1
string
field_2
string
field_3
string
inbound_calls_blocked
boolean
outbound_calls_blocked
boolean
archived_at
null | string Timestamp when the contact was archived. `null` for active contacts.
emails▾
array
email
string
is_primary
boolean
phones▾
array
phone
string
is_primary
boolean
image▾
null | object
id
string
ESC