v4

latestOpenAPI 3.1.0MIT2026-08-02128224900.7 KB
Notes

List Notes

List all notes

get/notes

Query parameters

model_type'automation' | 'comment' | 'conversation' | 'email' | 'external_feed' | 'invitation' | 'socialmention' | 'stripe_customer' | 'subscriber' | 'survey' | 'tag' | 'webmention'

Filter notes by the type of object they are attached to.

Filter notes by the type of object they are attached to.

model_idstring

Filter notes by the UUID or TypeID of the object they are attached to.

Filter notes by the UUID or TypeID of the object they are attached to.

expandstring[]

If provided, expand the given field.

If provided, expand the given field.

pageinteger

The page number of the paginated response.

Example:1

The page number of the paginated response.

Response

OK

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.

Example response

{
  "results": [
    {
      "body": "This subscriber upgraded to a paid plan.",
      "model_type": "email",
      "model_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
      "source": "admin"
    }
  ]
}