Skip to main content
GET
List schedules

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Query Parameters

scope
string | null

mine (default) or workspace (admin only).

state
string | null

Explicit lifecycle state filter - passes through verbatim. When set (e.g. state=archived), include_archived is ignored.

include_archived
boolean

When no explicit state filter is supplied, default behaviour EXCLUDES archived rows so the "your schedules" view shows the working set (active + paused + quarantined). Set include_archived=true for the audit history view.

limit
integer<int64> | null
offset
integer<int64> | null

Row offset for the admin paginator. Ignored for scope=mine.

owner_user_id
string<uuid> | null

Restrict a workspace-scope listing to one owner (the admin "filter by user" dropdown). Ignored for scope=mine (which is already pinned to the caller).

Response

Schedules

limit
integer<int64>
required
offset
integer<int64>
required
schedules
object[]
required
total
integer<int64>
required

Total rows matching the filter (ignoring limit/offset) - the admin paginator's denominator. For scope=mine this equals the page size today (no paging on the personal view) but is still returned.