OmnioDocsAPI referenceOpen the app

Get conversation

GET/v1/conversations/{conversation_id}

One conversation, with its window and unread count.

Scope conversations:read

Path parameters

conversation_idstring, uuidRequired

Response

  • 200Success
Response fields
idstringRequired
channel_idstringRequired
channelobjectRequired
channel.idstringRequired
channel.namestringRequired
channel.typestringRequired
channel.display_phone_numberstringRequired
May be null
statusstringRequired
assignee_member_idstringRequired
May be null
snoozed_untilstring, date-timeRequired
May be null
assigneeobjectRequired
May be null
assignee.member_idstringRequired
assignee.display_namestringRequired
assignee_team_idstringRequired
May be null
assignee_teamobjectRequired
May be null
assignee_team.team_idstringRequired
assignee_team.namestringRequired
contactobjectRequired
contact.customer_idstringRequired
contact.namestringRequired
May be null
contact.phone_e164stringRequired
May be null
contact.usernamestringRequired
May be null
lifecycle_stageobjectRequired
May be null
lifecycle_stage.stage_idstringRequired
lifecycle_stage.namestringRequired
lifecycle_stage.colorstringRequired
last_read_seqintegerRequired
unread_countintegerRequired
last_message_atstring, date-timeRequired
May be null
last_message_previewstringRequired
May be null
last_inbound_atstring, date-timeRequired
May be null
windowenumRequired
One of open, closing, closed, none
window_expires_atstring, date-timeRequired
May be null
created_atstring, date-timeRequired

Errors

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

Every error has the same shape. See Errors.