Search notes

get

https://{tenant}.onechurchsoftware.com/api/notes/{type}

Retrieve the notes attached to records of the given type. For person notes, view selects between the person's own notes, their family's notes or both. The required permission depends on the note's link type: people and family notes require Read Notes; groups notes require group admin access with note permissions (Limited Write Groups); batches notes require Limited Read Contributions; other link types follow the permissions of the record the notes are attached to.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type

string

required

The type of record to return notes for. Accepted values: people, connection, queue_people, batches, groups, plan_item, plan, reconciliations, family, business, workflow_people.

Query Params

comments

string

Return notes whose comments contain the given text.

types

string

Comma-delimited list of note type ids. Only person, batch and group notes have types; values come from /api/property_values/person_note_types/values, batch_note_types and group_note_types respectively.

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". Only applicable when type is people.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK