Search workflows

get

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

Retrieve a list of workflows matching the given filters, with a per-status count of the entries in each.

Required permission: Full Read Workflows

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return workflows whose name contains the given text.

tasks.start

double

Return workflows with at least this many tasks.

tasks.end

double

Return workflows with at most this many tasks.

enabled

boolean

Whether to return only enabled (true) or only disabled (false) workflows. If omitted, both are returned.

category

string

Comma-delimited list of workflow category ids or codes. Values come from /api/property_values/workflow_categories/values. Use -1 to return workflows with no category.

filter

string

Return workflows whose name contains the given text.

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