Skip to main content
GET
List report schedules

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:next_run_at

Field to sort by

Available options:
name,
next_run_at,
created_at
orderDirection
enum<string>
default:asc

Sort direction

Available options:
asc,
desc
companyId
string<uuid>

Filter by company ID

status
enum<string>

Filter by schedule status

Available options:
active,
paused,
completed,
error

Response

List of report schedules

data
object[]
required

Array of report schedules

pagination
object
required