Skip to main content
GET
Get schedule

Authorizations

x-api-key
string
header
required

Lyzr API key. Required on every endpoint except Trigger Webhook.

Path Parameters

schedule_id
string
required

ID of the schedule.

Example:

"66f1c2a9e4b0a1b2c3d4e5f6"

Response

The schedule.

id
string
required

Unique schedule ID.

Example:

"66f1c2a9e4b0a1b2c3d4e5f6"

user_id
string
required
Example:

"user@example.com"

agent_id
string
required
Example:

"66e9b0f2a1c3d4e5f6a7b8c9"

message
string
required
Example:

"Summarize yesterday's support tickets and flag anything urgent."

cron_expression
string
required
Example:

"0 9 * * 1-5"

timezone
string
required
Example:

"Asia/Kolkata"

created_at
string<date-time>
required
max_retries
integer
default:3
retry_delay
integer
default:60
is_active
boolean
default:true

false when the schedule is paused.

updated_at
string<date-time> | null
next_run_time
string<date-time> | null

When the schedule will next fire. null while paused.

last_run_at
string<date-time> | null
last_run_success
boolean | null

Outcome of the most recent run. null if the schedule has never run.