OmnioDocsAPI referenceOpen the app

Search contacts and messages

GET/v1/search

Contacts and messages matching q, in two groups with their own limit and cursor.

A key gets the groups its scopes allow: contacts:read, messages:read, one at least.

Scope contacts:read or messages:read

Query parameters

qstringRequired
Up to 100 characters
contacts_limitinteger
1 to 100. Default 20
contacts_cursorstring
messages_limitinteger
1 to 100. Default 20
messages_cursorstring

Response

  • 200Success
Response fields
contactsobject
May be null
contacts.dataarray of objectRequired
contacts.next_cursorstringRequired
May be null
messagesobject
May be null
messages.dataarray of objectRequired
messages.next_cursorstringRequired
May be null

Errors

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

Every error has the same shape. See Errors.