Search task visits

get

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

Retrieve the individual visits recorded as people pass through workflow tasks, newest first (oldest first when profile is supplied).

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 visits to its tasks.

task

int32

≥ 1

The id of a workflow task; returns only visits to that task. Task ids come from /api/workflows/{workflow}/tasks/list.

profile

int32

≥ 1

The id of a person; returns only that person's visits (oldest first).

done

boolean

Whether to return only visits that completed the workflow (true) or only visits that did not (false). If omitted, both are returned.

timestamp.start

date-time

Return visits on or after this date/time.

timestamp.end

date-time

Return visits on or before this date/time.

string

Return visits by people whose email (or whose family's email) contains the given text.

phone

string

Return visits by 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