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

Comma-delimited list of data sources of queries to return. Allowed values: people, contributions, groups. AI-generated reports carry the same data sources as classic queries. Omit to return queries for all data sources.

aiReport

boolean

When true, only AI-generated reports are returned; when false, only classic query-builder queries. Omit to return both. Only narrows results the caller would already receive: it never adds AI reports for callers that did not opt into them.

personSets

boolean

When true, AI-generated reports that define a set of people are returned alongside the module's classic queries. Used by pickers whose consumer resolves people (workflow triggers, access criteria, check-in rooms). The flag also excludes AI reports that define no person set, including when Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.Module is omitted.

includeAiReports

boolean

When true, AI-generated reports are returned alongside the module's classic queries, whether or not they define a person set. AI reports follow the Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.Module filter like classic queries; without this flag (or Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.PersonSets) they are excluded. Used by the Query Builder's saved-query switcher and the scheduler/widget pickers; person-set pickers use Eira.Api.Domain.ViewModels.Reporting.QuerySearchCriteria.PersonSets instead.

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.

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