OmnioDocsAPI referenceOpen the app

List conversations

GET/v1/conversations

Conversations, newest first.

Filter by view, status, window, assignee, team, customer, channel, lifecycle stage, tag and unread.

Scope conversations:read

Query parameters

viewenum
One of mine, unassigned, team, mentions, all, resolved, snoozed
statusenum
One of open, pending, snoozed, resolved
windowenum
One of open, closing, closed, none
assignee_member_idstring, uuid
assignee_team_idstring, uuid
customer_idstring
Up to 64 characters
channel_idstring, uuid
lifecyclearray of string
Up to 20 items
tag_idstring, uuid
unreadboolean
limitinteger
1 to 200. Default 50
cursorstring

Response

  • 200Success
Response fields
dataarray of objectRequired
data[].idstringRequired
data[].channel_idstringRequired
data[].channelobjectRequired
data[].statusstringRequired
data[].assignee_member_idstringRequired
May be null
data[].snoozed_untilstring, date-timeRequired
May be null
data[].assigneeobjectRequired
May be null
data[].assignee_team_idstringRequired
May be null
data[].assignee_teamobjectRequired
May be null
data[].contactobjectRequired
data[].lifecycle_stageobjectRequired
May be null
data[].last_read_seqintegerRequired
data[].unread_countintegerRequired
data[].last_message_atstring, date-timeRequired
May be null
data[].last_message_previewstringRequired
May be null
data[].last_inbound_atstring, date-timeRequired
May be null
data[].windowenumRequired
One of open, closing, closed, none
data[].window_expires_atstring, date-timeRequired
May be null
data[].created_atstring, date-timeRequired
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.