Search plan notes

get

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

Retrieve the notes on a plan. Returns plan-level notes unless the item parameter narrows the search to a specific line item.

Required permission: Full Read Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the plan

Query Params

comments

string

Include notes which contain this text.

created.start

date-time

Include notes created after this date and time.

created.end

date-time

Include notes created before this date and time.

modified.start

date-time

Include notes last modified after this date and time.

modified.end

date-time

Include notes last modified before this date and time.

category

string

Comma-delimited list of note category ids. Values come from /api/plans/servicetypes/{id}/notes/categories.

team

string

Comma-delimited list of team (group) ids the note applies to.

item

int32

≥ 1

Restrict the search to notes on a specific line item. When omitted, only plan-level notes are returned.

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