Search workflow logs

get

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

Retrieve the activity log entries workflows write as they process people, newest first (oldest first when person is supplied). Without workflow, only entries not tied to a specific workflow are returned.

Required permission: Full Read Workflows

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

workflow

int32

≥ 1

The id of the workflow to return logs for. When omitted, only log entries not tied to a specific workflow are returned.

task

int32

≥ 1

The id of a workflow task; returns only logs written by that task.

person

int32

≥ 1

The id of a person; returns only log entries covering that person (oldest first).

int32

≥ 1

The id of a specific log entry.

message

string

Return log entries whose message contains the given text.

count.start

double

Return log entries covering at least this many people.

count.end

double

Return log entries covering at most this many people.

created.start

date-time

Return log entries written on or after this date/time.

created.end

date-time

Return log entries written on or before this date/time.

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