Get person notes

get

https://{tenant}.onechurchsoftware.com/api/people/{id}/notes

Retrieve the notes attached to the given person, optionally including their family's notes.

Required permission: Read Notes

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Query Params

comments

string

Return notes whose comments contain the given text.

types

string

Comma-delimited list of note type ids. Values come from /api/property_values/person_note_types/values.

date.start

date-time

Return notes dated on or after this date.

date.end

date-time

Return notes dated on or before this date.

view

string

Which notes to return: "individual" (the person's own notes), "family" (their family's notes) or "all".

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

200OK