List runs

/v1/schedules/{id}/runs

Newest first. Readable after the schedule is deleted.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

idstringrequired

Schedule id (job_…)

Query parameters

statusenum<string>

Only runs in this state

Available options: running, completed, failed, cancelled

limitinteger

Page size, 1–100 (default 20)

Required range: 1 <= x <= 100

offsetinteger

Rows to skip

Required range: x >= 0

Response

A page of runs Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

runsobject[]

Show child attributes

idstring

The scheduler’s run id

schedule_idstring

statusenum<string>

Available options: running, completed, failed, cancelled

started_atinteger | null

ms epoch

ended_atinteger | null

ms epoch

duration_msinteger | null

execution_idstring | null

The id the executions, results and cancel routes take; null until the engine run exists

triggered_bystring | null

errorstring | null

The recorded error, clipped to 300 characters

totalinteger

limitinteger

offsetinteger

has_moreboolean

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

schedule_not_found — no schedule with that id for this key (a foreign, missing or deleted id answers alike); not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

invalid_params — a field is missing or malformed (the envelope names it); nothing was written

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

scheduler_error — the scheduler failed or did not answer; no detail is returned, retry

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.get( "https://api.plungeai.com/v1/schedules/{id}/runs", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/schedules/{id}/runs', { method: 'GET', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, }, }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/schedules/{id}/runs")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .GET() .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

{ "runs": [ { "id": "<string>", "schedule_id": "<string>", "status": "running", "started_at": 0, "ended_at": 0, "duration_ms": 0, "execution_id": "<string>", "triggered_by": "<string>", "error": "<string>" } ], "total": 0, "limit": 0, "offset": 0, "has_more": true }

Authorizations

Path parameters

Query parameters

Response

Planned: TI-33

Planned: TI-34