Skip to main content
GET
List notes

Authorizations

Authorization
string
header
required

A Parley API key.

Query Parameters

projectId
string

Only the notes on this project. Pass exactly one of projectId, accountId, or contactId.

Minimum string length: 1
accountId
string

Only the notes on this account. Pass exactly one of projectId, accountId, or contactId.

Minimum string length: 1
contactId
string

Only the notes on this contact. Pass exactly one of projectId, accountId, or contactId.

Minimum string length: 1

Case-insensitive. Only notes whose title contains this text.

Minimum string length: 1
createdSince
string

Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

createdBefore
string

Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedSince
string

Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

updatedBefore
string

Only records last updated before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.

sort
enum<string>
default:-createdAt

Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.

Available options:
name,
-name,
createdAt,
-createdAt,
updatedAt,
-updatedAt
cursor
string

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

Minimum string length: 1
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 250

Response

OK

data
object[]
required
nextCursor
string | null
required

Cursor for the next page, or null on the last page.