List notes

get

https://{apiHost}/api/v2/public/notes

Retrieve a paginated list of activity log notes. Notes are used to track
communications, observations, and important events for clients, caregivers,
and leads.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 20

Maximum number of results to return (1-100)

offset

integer

≥ 0

Defaults to 0

Number of results to skip for pagination

entityType

string

enum

Filter by entity type

Allowed:

entityId

string

Filter by entity ID (use with entityType)

clientId

string

Filter by related client ID (shortcut for entityType=client)

caregiverId

string

Filter by related caregiver ID (shortcut for entityType=caregiver)

leadId

string

Filter by related lead ID (shortcut for entityType=lead)

categoryId

string

Filter by note category ID

communicationType

string

enum

Filter by communication type

authorId

string

Filter by author user ID

createdSince

date-time

Filter notes created on or after this date (ISO 8601)

createdBefore

date-time

Filter notes created before this date (ISO 8601)

occurrenceSince

date-time

Filter notes with occurrence on or after this date (ISO 8601)

occurrenceBefore

date-time

Filter notes with occurrence before this date (ISO 8601)

includeArchived

boolean

Defaults to false

Include archived notes (default false)

Responses

200Successful response

401Authentication failed - invalid or missing API key