OmnioDocsAPI referenceOpen the app

List contacts

GET/v1/contacts

Contacts, newest first or by sort and order.

Search q, filter by lifecycle, tag, channel and status.

Scope contacts:read

Query parameters

qstring
Up to 100 characters
lifecyclestring
tag_idstring, uuid
channel_idstring, uuid
statusenum
One of active, blocked, deleted
limitinteger
1 to 200. Default 50
cursorstring
sortenum
One of created_at, customer_id, name, username, phone, channel, lifecycle, language, last_message_at. Default created_at
orderenum
One of asc, desc. Default desc

Response

  • 200Success
Response fields
dataarray of objectRequired
data[].customer_idstringRequired
data[].first_namestringRequired
May be null
data[].last_namestringRequired
May be null
data[].usernamestringRequired
May be null
data[].phone_e164stringRequired
May be null
data[].emailstringRequired
May be null
data[].languagestringRequired
May be null
data[].lifecycleobjectRequired
May be null
data[].tagsarray of objectRequired
data[].collaboratorsarray of stringRequired
data[].attributesobjectRequired
data[].statusstringRequired
data[].channel_idstringRequired
May be null
data[].last_message_atstringRequired
May be null
data[].last_message_previewstringRequired
May be null
data[].created_atstringRequired
data[].updated_atstringRequired
data[].deleted_atstringRequired
May be null
next_cursorstringRequired
May be null

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 422validation_error. details.fields names each field at fault

Every error has the same shape. See Errors.