Search queries

get

https://{tenant}.onechurchsoftware.com/api/reporting/queries

Retrieve the saved queries available to the caller. A query's results can be retrieved using the query results endpoint.

Required permission: Reporting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

module

string

The kind of queries to return. Allowed values: people, contributions, groups. Omit to return queries for all modules.

name

string

Return queries whose name contains the given text.

description

string

Return queries whose description contains the given text.

lastUsed.start

date-time

Return queries last used on or after this date.

lastUsed.end

date-time

Return queries last used on or before this date.

access

string

Comma-delimited list of access level ids: 1 (Private), 2 (Specified people), 3 (Anyone can view), 4 (Anyone can edit).

owner

int32

≥ 1

The id of the person who owns the query.

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