Skip to main content

List scheduled jobs

POST 

/api/v1/scheduler/list-jobs

Returns a paginated list of scheduled jobs for the authenticated tenant and project. Optionally filter by lifecycle state or target kind.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Manage jobs

Request​

Responses​

Scheduled jobs returned

List jobs visible in the authenticated scope with default paging.​

Section ID: DOC-CP-scheduling-api-listJobs#example-scheduled-jobs-listJobs-request

Request example

{}

Guide request for Variant: show the user’s reminder list. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-CP-scheduling-api-listJobs#example-cookbook-core-platform-scheduling-managing-02-request

Request example

{
"pageSize": 20,
"stateFilter": "SCHEDULE_STATUS_ACTIVE"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-scheduling-api-listJobs#example-scheduled-jobs-listJobs-response

Response example

{
"schedules": [
{
"scheduleId": "sched_a1b2c3d4e5f60718",
"tenantId": "example_123",
"projectId": "example_123",
"ownerSubject": "example",
"name": "example",
"description": "example",
"scheduleType": "SCHEDULE_TYPE_CRON",
"cronExpression": "0 9 * * *",
"timezone": "example",
"scheduledAt": "2026-09-16T12:00:00Z",
"intervalSeconds": 1,
"target": {
"url": "https://example.com/callback",
"method": "example",
"kind": "example"
},
"state": "SCHEDULE_STATUS_ACTIVE",
"retryPolicy": {
"maxAttempts": 1,
"initialBackoffMs": 1,
"maxBackoffMs": 1
},
"metadata": {
"example": "value"
},
"autoPauseThreshold": 1,
"externalId": "example_123",
"createdAt": "2026-09-16T12:00:00Z",
"createdBySubject": "example",
"updatedAt": "2026-09-16T12:00:00Z",
"updatedBySubject": "example",
"pausedAt": "2026-09-16T12:00:00Z",
"pausedBySubject": "example",
"pausedReason": "example",
"resumedAt": "2026-09-16T12:00:00Z",
"resumedBySubject": "example",
"deletedAt": "2026-09-16T12:00:00Z",
"deletedBySubject": "example",
"lastTriggeredAt": "2026-09-16T12:00:00Z",
"nextTriggerAt": "2026-09-16T12:00:00Z",
"triggerCount": "1",
"failureCount": "1",
"consecutiveFailureCount": "1"
}
],
"nextPageToken": "example",
"totalCount": 1
}

Document ID: DOC-CP-scheduling-api-listJobs. Section identities and revisions.

SectionStable reference
List scheduled jobsDOC-CP-scheduling-api-listJobs#overview
RequestDOC-CP-scheduling-api-listJobs#request
ResponsesDOC-CP-scheduling-api-listJobs#responses