Skip to main content
GET
List reports

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page
number
default:1

Page number

Required range: x >= 1
limit
number
default:20

Items per page

Required range: 1 <= x <= 100
orderBy
enum<string>
default:created_at

Field to sort by

Available options:
title,
created_at,
updated_at
orderDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
companyId
string<uuid>

Filter by company ID

status
enum<string>

Filter by status

Available options:
draft,
published
reportTypeId
string<uuid>

Filter by report type ID

Response

List of reports

data
object[]
required

Array of reports

pagination
object
required