Sign in
Conversation

Retrieves list of all inbox conversations

get/chat/conversations

Query parameters

pageinteger

The page number to be displayed

items_per_pageinteger

The items per page to be displayed

statusstring[]

The status(es) of conversations to filter the results by

typestring[]

The type(s) of conversations to filter the results by

user_idstring[]

The user_id of participant of the conversations to filter the results by

sortBystring[]

The field to sort by together with sorting order example updated_at, -updated_at

created_at_fromstring date-time

Created at more than equal to the time provided

created_at_tostring date-time

Created at to less than the time provided

closed_at_fromstring date-time

Closed at more than equal to the time provided

closed_at_tostring date-time

Closed at to less than the time provided

mediumstring[]

Medium of the conversation

team_team_id_existsboolean

Filter conversations based on team existence

team_team_idstring[]

Filter conversations based on team_id

chatterbox_profiles_existsboolean

Filter conversations based on chatterbox profile existence

chatterbox_profiles_entity_idstring[]

Filter conversations based on chatterbox profile entity id

closed_by_user_idstring[]

Filter conversations based on user id which closed the conversation

Headers

Authorizationstring string required

OAuth Bearer token

Contextstring string required

The executing context

Accept'application/json' required

Advertises which content types the client understands

X-Accept-Timezonestring

The timezone the content will be displayed in

Response

List of all inbox conversations will be returned

_idstring required
updated_atstring date-time required
created_atstring date-time required
__vinteger required
conversation_uuidstring uuid
medium'sms' | 'chat' | 'whatsapp'
type'candidate_support' | 'system_support' | 'candidate_support_initiated' | 'system_support_initiated' | 'client_support_initiated' | 'client_support' | 'guest_support'
namestring
first_messagestring
channel_idstring required
channel_attributesobject required
status'open' | 'closing' | 'closed' | 'orphan' | 'archived' required
note_channel_idstring required
note_channel_attributesobject required
guest_reasonstring
closed_by_user_idstring
closed_atstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.