Appearance
List scheduled jobs โ
GET /v1/admin/system/cron
- Operation ID:
listSystemCronJobs - Tags: System
- Base URL:
http://localhost:8787
pg_cron jobs with their latest run. Read with an admin (service-role) transaction because pg_cron tables have no staff policy.
Workflow: Integration guide.
Authentication: staff Bearer JWT with permission system.read.
Authentication โ
- Auth: staff Bearer JWT (
Authorization: Bearer <access_token>) with the permissions below. - Required permissions:
system.read
Parameters โ
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | Default: 10. Greater than: 0. Max: 50 |
Responses โ
200 โ
Jobs.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
data | (object (SystemCronJob))[] | yes | - |
data[].jobid | integer | yes | - |
data[].jobname | string | null | yes | - |
data[].schedule | string | yes | Cron expression. |
data[].command | string | yes | - |
data[].active | boolean | yes | - |
data[].last_run | object | null | yes | Most recent run, null when the job never ran. |
data[].last_run.status | string | null | yes | - |
data[].last_run.start_time | string | null | yes | - |
data[].last_run.end_time | string | null | yes | - |
data[].last_run.return_message | string | null | yes | - |
Errors โ
400 โ
Request validation failed.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ValidationErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | yes | One of: false |
error | object | yes | - |
error.name | string | yes | One of: "ZodError" |
error.issues | object[] | yes | - |
error.issues[].code | string | yes | - |
error.issues[].path | (string | number)[] | yes | - |
error.issues[].message | string | yes | - |
Request validation
json
{
"success": false,
"error": {
"name": "ZodError",
"issues": [
{
"code": "custom",
"path": [
"field"
],
"message": "Invalid value"
}
]
}
}401 โ
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}403 โ
Authenticated but lacking the required permission. details.perm lists the accepted permission keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "forbidden",
"details": {
"perm": "system.read"
}
}500 โ
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}Examples โ
curl โ
bash
curl -X GET 'http://localhost:8787/v1/admin/system/cron' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript โ
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/admin/system/cron", {
method: "GET",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();