API Reference

Returns a paginated list of notes for a given entity.

get
https://example.com/v2/notes

Both entity_type and entity_id are required. Pinned notes come first, then newest. Pass
pinned_only=true to restrict to pinned notes. Notes belonging to entities outside the API
key's scope are not returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
0 to 2147483647
int32
1 to 100
string
enum
required

Entity types exposed via the Open API. This is a deliberate subset of Domain.Enums.EntityType;
only types that have a corresponding Open API endpoint are allowed for document operations.
Numeric values match Domain.Enums.EntityType so direct casts are safe.

int64
required
boolean
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 3 months ago

Did this page help you?