Deployments.ai Docs
Automations

List schedules

GET /v1/schedules · SDK listSchedules · CLI deployments schedule list

GET
/v1/schedules

Requires schedules:read.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length <= 4096
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

ListSchedulesResponse

application/json
  1. response
nextCursor?|null
schedules*array<>
curl -X GET "https://example.com/v1/schedules"
{  "nextCursor": "string",  "schedules": [    {      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "version": 0,      "environmentId": "string",      "organizationId": "string",      "projectId": "string",      "workspaceId": "string",      "agentDeploymentId": "string",      "createdBy": {        "id": "string",        "type": "agent"      },      "createdFrom": {        "runId": "string",        "threadId": "string",        "toolCallId": "string",        "toolName": "string"      },      "id": "string",      "name": "string",      "nextRunAt": "2019-08-24T14:15:22Z",      "object": "schedule",      "prompt": "string",      "schedule": {        "expression": "string",        "timezone": "string"      },      "status": "active",      "threadId": "string"    }  ]}