Skip to content

List Customer Notes

EndpointMethod
/api/admin/customers/{customerId}/notesGET

The notes that appear on the customer's view screen, returned newest-first.

Path Parameters

ParameterTypeRequiredDescription
customerIdintegeryesThe customer whose notes to list. Unknown customer → 404.

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number.
per_pageintegerItems per page.

Response Fields

Each row in data:

FieldTypeDescription
idintegerNote ID.
notestringThe note text.
customerIdintegerThe customer this note belongs to.
customerNotifiedbooleanWhether the customer was emailed when the note was added.
createdAtstringWhen the note was created.

The meta object carries currentPage, perPage, lastPage, total, from, and to.

TIP

For how the notes log works (append-only, customer-notify), see the Notes overview.

All admin endpoints require an admin Bearer token — see Authentication.

Released under the MIT License.