Skip to main content
GET
List notes for the caller's tenant.

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:1

Page number, 1-indexed. Clamped to >= 1.

per_page
integer
default:50

Results per page. Clamped to the range 1-100 (values outside are silently capped, not rejected).

entity_uuid
string | null

Filter notes associated with this entity UUID.

entity_type
enum<string> | null

Entity type for entity_uuid filter. Must be one of (uppercase): PERSON, COMPANY, FILE, TASK, OPPORTUNITY. Required when entity_uuid is set.

Available options:
PERSON,
COMPANY,
FILE,
TASK,
OPPORTUNITY
search
string | null

Full-text search over note subject and excerpt (case-insensitive).

sort_by
enum<string> | null
default:date

Field to sort by. Valid values: date, created_at, updated_at.

Available options:
date,
created_at,
updated_at
order
enum<string>
default:desc

Sort order. Valid values: asc (ascending), desc (descending).

Available options:
asc,
desc

Response

200 - application/json

Paginated list of notes.

items
NoteResponse · object[]
required
page
integer
required
per_page
integer
required
total
integer
required