Conversations (Messages)
Messages

Get messages by conversation

Changed on

Retrieves messages for a conversation.

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

Legacy RoleEquivalent Permission Set Role
org.user.message.readorg.permission.message.read
get/conversations/{id}/messages

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/conversations/{id}/messages
  • Auth: httpBearer (a scheme the document does not define)

Path parameters

idstring required
Example:57c8d2b01a57ed1400392073

Unique ID of the conversation.

Query parameters

pagenumber
Example:1

Number of pages to return for results. Default value: 1.

pageSizenumber
Example:100

Number of results to return per page. Default value: 100.

include'attachments'
Example:attachments

List of resources to include in this response. Use a comma to separate resources. Supports the attachments resource.

Response

OK

Changes

  • 96bcf1492edcRevision changes
    • info

      added the optional property /// to the response with the status

  • bb9f694ef5e0Revision changes
    • breaking

      the query request parameter include was restricted to a list of enum values

    • info

      added the new enum value attachments to the query request parameter include

    • info

      added the optional property to the response with the status