Skip to main content
GET
List the member's notes

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Headers

If-None-Match
string

ETag from a previous response.

Query Parameters

filter[contact_id]
string<uuid>

Only notes on this contact. A contact that is not the member's matches nothing.

filter[pinned]
boolean

true lists pinned notes; false lists the rest.

page[cursor]
string

Opaque cursor from meta.pagination.next_cursor. A cursor issued for other filters, another sort or another member restarts at the first page; a malformed, tampered or expired one (older than three days) returns 400.

page[limit]
integer
default:25

Page size. Defaults to 25, at most 100.

Required range: 1 <= x <= 100

Response

One page of notes.

One page of notes.

status
integer
required
data
object[]
required
meta
object
required

Envelope metadata present on every response.