List an order's notes

Lists the notes on an order, one page at a time.

GET /orders/{order_id}/notes

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/notes?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "attachments": [
        {
          "uuid": "<string>",
          "filename": "<string>",
          "content_type": "<string>",
          "size": 123,
          "href": "<string>"
        }
      ],
      "content": "<string>",
      "created_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "created_on": "<string>",
      "group": "<unknown>",
      "href": "<string>",
      "id": "<string>",
      "last_updated_by": {
        "name": "<string>",
        "object": "<string>"
      },
      "last_updated_on": "<string>",
      "object": "<string>",
      "order": {
        "href": "<string>",
        "id": "<string>",
        "object": "<string>"
      },
      "user": "<unknown>",
      "version": 123,
      "watchers": [
        {
          "email": "<string>",
          "name": "<string>",
          "type": "<string>"
        }
      ]
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Pass the order’s id. The records are under data, and pagination holds the cursor for the next page.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

order_id · string · required

The order's id, as GET /orders lists it.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor from the previous page, to fetch the page after it.

sort · string

The field to sort by. Prefix it with - to sort in descending order.

Example:

"-created_on"

Response

200 - application/json

One page of notes, under data.

data · object[]

Show child attributes

object · string

pagination · object

Cursor paging for the listing.

Show child attributes

url · string