PAparley
Notes

List notes

List the notes on one project, account, or contact, newest first by default: pass exactly one of projectId, accountId, or contactId. Rows leave out the content; get a note by ID to read it. Returns 400 INVALID_REFERENCE when the record doesn't exist or you can't see it.

get/notes

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/notes
  • Auth
    HTTP bearer

Query parameters

projectIdstring

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

accountIdstring

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

contactIdstring

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

searchstring

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

createdSincestring

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

createdBeforestring

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

updatedSincestring

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

updatedBeforestring

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

sort'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'

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

cursorstring

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

limitinteger

Maximum number of items to return.

Response

OK

nextCursorstring nullable required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.