Search workflow completions

get

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

Retrieve, per person and workflow, when they first and most recently completed the workflow and how many times, most recent first.

Required permission: Full Read Workflows

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

workflow

int32

≥ 1

The id of a workflow; returns only completions of that workflow.

workflowName

string

Return completions of workflows whose name contains the given text.

profile

int32

≥ 1

The id of a person; returns only that person's completions.

earliest.start

date-time

Return rows whose first completion is on or after this date/time.

earliest.end

date-time

Return rows whose first completion is on or before this date/time.

latest.start

date-time

Return rows whose most recent completion is on or after this date/time.

latest.end

date-time

Return rows whose most recent completion is on or before this date/time.

count.start

double

Return rows with at least this many completions.

count.end

double

Return rows with at most this many completions.

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