Requests and responses

All documented endpoints use the /v1 version prefix. Send UTF-8 JSON with Content-Type: application/json unless the endpoint returns a downloadable artifact.

Resource methods

• POST /{resource} creates a resource.
• POST /{resource}/list lists resources with body-based filters and pagination.
• GET /{resource}/{id} gets one resource.
• PATCH /{resource}/{id} updates only supplied fields.
• DELETE /{resource}/{id} deletes one resource.
• Named POST actions, such as /manual-run, perform a documented action.

Unknown request fields are rejected on write operations where the endpoint defines a strict payload. Treat field names and enum values as case-sensitive unless the endpoint says otherwise.

Success responses

JSON success responses wrap the endpoint payload in data:

{  "status": "success",  "data": {    "id": "65f0c9bca7d6b4e2c7654321"  }}

List responses add pagination, sort, and filters at the top level:

{  "status": "success",  "sort": "created-desc",  "filters": { "status": "active" },  "pagination": {    "limit": 25,    "has_more": false  },  "data": {    "schedules": []  }}

Create operations normally return 201 Created; reads and updates return 200 OK. Download endpoints return their documented media type instead of a JSON envelope.

Dates, IDs, and nulls

• Resource IDs are 24-character hexadecimal strings.
• Timestamps in responses are RFC 3339 instants in UTC with a Z suffix and millisecond precision, for example 2026-10-10T10:10:22.316Z. A timestamp the server does not have is null, never an empty string.
• Timestamps you send (list filters such as created_at_since, created_from and created_to, report time_range, and pagination after_value) must carry an explicit offset or Z. Values without one, and date-only values, are rejected with 400.
• API-key expiration uses a date-only YYYY-MM-DD value: the key is valid through the end of that day in UTC.
• Cron expressions are evaluated in UTC.
• Optional response fields can be omitted or null; clients should tolerate both where the schema permits them.

The console can display the same UTC instant in local time or UTC according to App settings → Time zone. This display choice does not change API values or UTC cron expressions. See Time zones and dates for the effect on filters, reports, and date variables.

Response headers

Every response includes:

Download responses and live log responses can include Cache-Control: no-store.