Skip to main content
GET
Get a List of Notes
Notes attached to workspace records. ⚠️ At least one filter is required — calling it bare returns HTTP 400 with “At least one argument is required”. Pass one of contact_id, account_id, opportunity_id, calendar_event_id, conversation_id, conversation_ids, contact_ids or a start_date. The spec marks every one of them optional individually, which is true only in the sense that no single one is mandatory.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

contact_id
string

Filter by a contact ID. At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

account_id
string

Filter by an account ID. At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

opportunity_id
string

Filter by an opportunity ID. At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

calendar_event_id
string

Filter by a calendar event ID. At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

conversation_id
string

Filter by a conversation ID. At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

conversation_ids
string[]

Filter by conversation IDs. At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

contact_ids
string[]

Filter by contact IDs. At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

start_date
string

Only include notes created on/after this date (when supported). At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

page
integer

Page number (when supported). At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

per_page
integer

Results per page (when supported). At least one filter is required on this endpoint; calling it with none returns HTTP 400 "At least one argument is required".

Response

Successful response

notes
string[]

Notes (when returned).

pagination
object

Pagination metadata (when returned).