Sign in
Candidate Conversation

List of all conversations for a specific candidate will be returned

get/chat/candidate/{candidate_id}/conversations

Query parameters

pageinteger

The page of documents to be displayed

items_per_pageinteger

The number of documents per page

typestring[]

The type of the conversation to be retrieved

statusstring[]

The status of the conversation to be retrieved

sortBystring[]

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

Response

List of all conversations for a specific candidate 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'
namestring
first_messagestring
channel_idstring required
channel_attributesobject required
status'open' | 'closing' | 'closed' | 'orphan' | 'archived' required
note_channel_idstring required
note_channel_attributesobject required

Changes

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