Skip to main content
GET
/
v1
/
notes
List
curl --request GET \
  --url https://{defaultHost}/v1/notes \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/notes"
  },
  "data": [
    {
      "id": "57fbf65d-8108-4d32-bbf1-4fe257b35db1",
      "object": "note",
      "body": "This is the body of note.",
      "metadata": {},
      "notable_id": "3c8ece7c-9ef0-4173-808c-cdbb75a5400d",
      "notable_type": "customer",
      "created_at": 1767909725,
      "updated_at": 1767909725
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
notable_id
string

The ID of the object that this note belongs to.

​
notable_type
string

The type of object that this note belongs to – one of customer, order, or subscription.

​
page
integer

The page of items you want returned.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.