API Reference
  1. One Church Software API
  2. Service Plans

Search item notes

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

Retrieve the notes on one of the plan's line items.

Required permission: Full Read Service Plans

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the plan

int32
required
≥ 1

The id of the line item

Query Params
string

Include notes which contain this text.

date-time

Include notes created on or after this date (the church's timezone; time of day is ignored).

date-time

Include notes created on or before this date (the church's timezone; time of day is ignored).

date-time

Include notes last modified on or after this date (the church's timezone; time of day is ignored).

date-time

Include notes last modified on or before this date (the church's timezone; time of day is ignored).

string

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

string

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

int32
≥ 0

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

int32
≥ 0

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

string

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

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.

Updated 5 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 5 months ago

Did this page help you?