Sign in
Business messages

Index messages for a business

Returns an array containing all messages sent to the business specified in the request URL regarding the given account.

get/v1/businesses/{business_id}/accounts/{account_id}/messages

Path parameters

business_idstring required
account_idstring required

Query parameters

page[size]integer

Specifies the number of entries to include in each results page.

page[number]integer

Specifies the number of results pages to return.

Response

Successful result of the operation.

idstring

ID of the message.

business_idstring

ID of the business to whom the message was sent.

person_idstring

ID of the person associated with the business to whom the message was delivered.

account_idstring

ID of the account for which the message was sent.

titlestring

The title of the message.

textstring

The text of the message.

required_notification_channel'any' | 'email'

The notification channel used to send the message.

created_atstring date-time

UTC timestamp from when the message was created.

Example response

[
  {
    "id": "f4ed772c970e1096a73d9418192a2d0camsg",
    "business_id": "567eaf2b22fce21a1920e14e11e2bfa3cbiz",
    "person_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
    "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
    "title": "Ihre Samsung Pay Bezahlung",
    "created_at": "2022-06-20T19:02:49Z"
  }
]