Skip to main content
GET
Get a note

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The note ID.

Minimum string length: 1

Response

OK

id
string
required

The note ID.

Minimum string length: 1
name
string
required

The note title.

location
object
required

The project, account, or contact the note is on.

version
integer
required

Goes up by one each time the content changes or the note is renamed through the API. Pass it as expectedVersion when updating the note.

Required range: 1 <= x <= 9007199254740991
createdAt
string<date-time>
required

When the note was created.

updatedAt
string<date-time>
required

When the note was last changed, including renames.

content
string
required

The note's markdown. References to files and folders look like @name [blocked] and @name/ [blocked].