Search visit totals

get

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

Retrieve per-person visit totals. With task, totals are that task's (and workflow/workflowName are ignored); otherwise one row is returned per person per workflow.

Required permission: Full Read Workflows

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

task

int32

≥ 1

The id of a workflow task; totals are per person for that task. Task ids come from /api/workflows/{workflow}/tasks/list.

workflow

int32

≥ 1

The id of a workflow; returns only that workflow's rows. Ignored when task is supplied.

workflowName

string

Return rows for workflows whose name contains the given text. Ignored when task is supplied.

profile

int32

≥ 1

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

visits.start

double

Return rows with at least this many visits.

visits.end

double

Return rows with at most this many visits.

earliest.start

date-time

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

earliest.end

date-time

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

latest.start

date-time

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

latest.end

date-time

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

string

Return rows for people whose email contains the given text.

phone

string

Return rows for people whose 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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK