List order messages

The order’s conversation with the customer, oldest first: external messages (visible to the customer) and internal staff notes. Needs the full orders.read scope; the _own scopes get 403.

GET/orders/{order_id}/messages

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

order_idstringrequired

Query parameters

internalboolean

true for notes only, false for external messages only. Default: both.

Responses

200

Messages

_embeddedobject

Show properties

itemsOrderMessage[]

Show properties

Array of OrderMessage

idinteger

bodystring

internalboolean

true for a staff note, hidden from the customer.

senderstring

authorobject | null

Show properties

idinteger

namestring

created_onstring<date-time>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

order_idpath*internalquery`true` for notes only, `false` for external messages only. Default: both.

Request

curl -X GET 'https://api.onbolder.com/v2/orders/string/messages' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/orders/string/messages", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/orders/string/messages",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_embedded": {
    "items": [
      {
        "id": 0,
        "body": "string",
        "internal": true,
        "sender": "admin",
        "author": {
          "id": 0,
          "name": "string"
        },
        "created_on": "2019-08-24T14:15:22Z"
      }
    ]
  }
}