Skip to main content
GET
List notes

Authorizations

Authorization
string
header
required

API key for authentication

Query Parameters

limit
integer
default:20

The number of items to return.

Required range: 1 <= x <= 100
cursor
string

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Maximum string length: 512
entity.id
string

Filter notes by entity. Only notes linked to the specified entity will be returned.

Required string length: 40
query
string

Full-text search query against note content.

Maximum string length: 500
createdAfter
string<date-time>

Return only notes created after this ISO 8601 timestamp.

Maximum string length: 100
createdBefore
string<date-time>

Return only notes created before this ISO 8601 timestamp.

Maximum string length: 100

Response

A paginated list of notes in the workspace.

data
object
required
Example:
deprecations
string[]
Example: