Skip to main content

List Sales Order Notes

GET 

/api/sales-orders/:salesOrder/notes

Lists the notes on a sales order, newest first, as a paginated set (15 per page).

Required scope: orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Query parameters:

  • page (integer, optional, default 1): Page number.

Each note includes:

  • id (integer), note (string), is_pinned (boolean), created_at (date-time)
  • link_type / link_id: The sales order the note belongs to.
  • user_id (integer|null) and user (object|null): The note's author.

Path parameters:

  • salesOrder (required): Sales order ID.

Request

Responses

OK

Response Headers
    Content-Type