Get schedule details
Learn more about get schedule details.
Use the Get schedule details to get the details of a schedule. This lets you confirm a schedule's configuration and last-run state before you change it.
HTTP method and endpoint
Use the following HTTP method and endpoint path to get schedule details.
GET {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/schedules/{schedule_id}The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
TenantURL | String | Yes | The base URL for your tenant. |
tenant_id | String | Yes | The unique identifier of your tenant. |
schedule_id | String | Yes | The unique identifier of the schedule. |
Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | <access_token> | Yes |
Request body
This operation does not require a request body.
Example request
Use the following example to see how a complete request is structured, with headers.
GET {TenantURL}/ai/agentflow/api/v202605/tenant-xyz/schedules/example-id
Authorization: <access_token>Response body
The following table describes the fields returned in the response body.
| Parameter | Type | Description |
|---|---|---|
schedule_id | String | The unique identifier of the schedule. |
tenant_id | String | The unique identifier of the tenant. |
agent_id | String | The unique identifier of the agent that the job or schedule runs. |
name | String | The display name. |
query | String | The prompt or query sent to the agent on each run. |
schedule_type | String | The type of schedule: recurring or run-once. |
cron_expression | String | The cron expression for the schedule, when schedule_type is recurring. |
interval_minutes | Integer | The interval in minutes between runs, when schedule_type is recurring. |
status | String | The status of the schedule: active, paused, running, cancelled, completed, or failed. |
next_run_at | String | The date and time of the next scheduled run. |
last_run_at | String | The date and time of the last run. |
run_count | Integer | The number of times this schedule has run. |
run_once | Boolean | Whether this is a one-time (run-once) schedule. |
last_conversation_id | String | The unique identifier of the conversation from the most recent run. |
created_by | String | The unique identifier of the user who created the schedule. |
created_at | String | The date and time when the job or schedule was created. |
updated_at | String | The date and time when the record was last updated. |
Example response
The following example shows a response with successful response.
{
"schedule_id": "sched-abc123",
"tenant_id": "tenant-xyz",
"agent_id": "my-support-agent",
"name": "Daily support escalation check",
"query": "Check for support tickets requiring escalation",
"schedule_type": "recurring",
"cron_expression": "0 9 * * MON-FRI",
"interval_minutes": 60,
"status": "active",
"next_run_at": "2025-05-14T09:00:00Z",
"last_run_at": "2025-05-13T09:00:00Z",
"run_count": 5,
"run_once": false,
"last_conversation_id": "conv-abc123",
"created_by": "user@example.com",
"created_at": "2025-05-01T10:00:00Z",
"updated_at": "2025-05-13T15:30:00Z"
}Error codes and recommended actions
The following table lists the possible error responses returned by this API.
| HTTP status | Description | Recommended action |
|---|---|---|
422 Unprocessable Entity | Validation Error | Review the request parameters or body, correct the invalid values, and resend the request. |