Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Get Conversation by External ID

Retrieves a single conversation using its unique external ID.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.conversation.read|org.permission.conversation.read|

Input

type: object properties: parameters: type: object properties: externalId: type: string required: - externalId title: Parameters

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: externalId: type: string name: type: string channels: type: string status: type: string messageCount: type: string noteCount: type: string satisfaction: type: string createdAt: type: string updatedAt: type: string modifiedAt: type: string tags: type: string suggestedTags: type: string sentiment: type: string lastMessageIn: type: string assignedUsers: type: string assignedTeams: type: string firstResponse: type: string direction: type: string outboundMessageCount: type: string rev: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string customer: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string messages: type: object properties: links: type: object properties: self: type: string createdBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string modifiedBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string