Skip to main content
GET
Retrieves the collection of ReportDefinition resources.

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:50

The number of items per page

Required range: 0 <= x <= 100
name
string
rootEntity
string
rootEntity[]
string[]
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
order[dateUpdated]
enum<string>
default:asc
Available options:
asc,
desc

Response

ReportDefinition collection

uuid
string
name
string
rootEntity
string
definition
(string | null)[]
owner
string<iri-reference> | null
Example:

"/api/v1/users/1"

dateCreated
string<date-time>
read-only
dateUpdated
string<date-time> | null
read-only