Search workflow notes

get

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

Retrieve a list of the notes logged on people as they move through workflows, most recent first.

Required permission: Full Read Workflows

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

personId

int32

≥ 1

The id of a person; returns only notes about that person.

workflow

int32

≥ 1

The id of a workflow; returns only notes logged in that workflow.

workflowName

string

Return notes whose workflow name contains the given text.

comments

string

Return notes whose comments contain the given text.

type

string

Comma-delimited list of note type ids. Values come from /api/property_values/workflow_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.

string

Return notes about people whose email (or whose family's email) contains the given text.

phone

string

Return notes about people whose phone number (or whose family's phone number) contains the given digits.

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