Get schedule

GET

https://api.devin.ai/v3/organizations/:org_id/schedules/:schedule_id

GET

/v3/organizations/:org_id/schedules/:schedule_id

curl https://api.devin.ai/v3/organizations/org_id/schedules/sched-abc123def456 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "agent": "devin",
  "consecutive_failures": 2,
  "created_at": "2024-04-10T08:15:30Z",
  "created_by": "jane.doe@example.com",
  "enabled": true,
  "frequency": "weekly",
  "last_error_at": "2024-04-09T14:22:10Z",
  "last_error_message": "Timeout error during execution",
  "last_executed_at": "2024-04-10T07:00:00Z",
  "name": "Weekly Data Sync",
  "notify_on": "failure",
  "org_id": "org-789xyz123",
  "playbook": {
    "playbook_id": "pbk-456def789",
    "title": "Data Synchronization Playbook"
  },
  "prompt": "Run the weekly data synchronization and report any discrepancies.",
  "scheduled_session_id": "sess-123abc456def",
  "updated_at": "2024-04-10T08:20:00Z",
  "bypass_approval": false,
  "interval_count": 1,
  "last_edited_by": "john.smith@example.com",
  "schedule_type": "recurring",
  "scheduled_at": "2024-04-10T07:00:00Z",
  "slack_channel_id": "C1234567890",
  "slack_team_id": "T0987654321",
  "tags": [
    "data-sync",
    "weekly",
    "automation"
  ],
  "target_devin_id": "devin-00123"
}

Get a specific schedule by ID.

Authentication

AuthorizationBearer

Personal API Key (apk_user_) or Service API Key (apk_)

Path parameters

schedule_idstringRequired

Schedule ID (prefix: sched-)

org_idstringRequired

Response

Successful Response

agentenum

Allowed values:

consecutive_failuresinteger

Number of consecutive failed executions.

created_atdatetime

ISO 8601 timestamp when the schedule was created.

created_bystring or null

User ID of the schedule creator.

enabledboolean

Whether the schedule is currently active.

frequencystring or null

How often the schedule repeats.

last_error_atdatetime or null

ISO 8601 timestamp of the most recent error.

last_error_messagestring or null

Error message from the most recent failed execution.

last_executed_atdatetime or null

ISO 8601 timestamp of the last execution.

namestring

Display name of the schedule.

notify_onenum

Allowed values:

org_idstring

Organization that owns this schedule (prefix org-).

playbookobject or null

promptstring

scheduled_session_idstring

updated_atdatetime

bypass_approvalbooleanOptionalDefaults to false

interval_countintegerOptionalDefaults to 1

last_edited_bystring or nullOptional

User ID of the last person to edit the schedule.

schedule_typeenumOptionalDefaults to recurring

Allowed values:

scheduled_atdatetime or nullOptional

slack_channel_idstring or nullOptional

slack_team_idstring or nullOptional

tagslist of strings or nullOptional

target_devin_idstring or nullOptional

Errors

422

Unprocessable Entity Error