Messages

Get messages

Retrieves messages for your Kustomer organization.

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

Legacy RoleEquivalent Permission Set Role
org.user.message.readorg.permission.message.read
get/messages

Request

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

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.

includestring
Example:attachments

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

sortstring
Example:desc

Option to sort results in descending order.

Response

OK

Changes

No recorded changes to this operation across all 8 revisions of this API.