scheduler-resource

Get an existing workflow schedule by name

Changed on Oct 10, 2026

get/api/scheduler/schedules/{name}

Request

Base URL
https://developer.orkescloud.com
Auth
API key in header X-Authorization
TypeScript
https://skmtc.dev/orkescloud/apis/orkes-conductor-api-server/docs/api/scheduler/schedules/:name/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Response

createTimeinteger

createdBystring

cronExpressionstring

descriptionstring

namestring

nextRunTimeinteger

pausedboolean

pausedReasonstring

runCatchupScheduleInstancesboolean

scheduleEndTimeinteger

scheduleStartTimeinteger

updatedBystring

updatedTimeinteger

zoneIdstring

Changes

Oct 10, 2026a142cbe9d486 Revision changes
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response property // became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property ///// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the // response's property type changed from no type to object for status
- breaking
  the // response's property type changed from no type to object for status
- breaking
  the // response's property type changed from no type to object for status
- breaking
  the // response's property type changed from no type to object for status
- breaking
  the /// response's property type changed from no type to object for status
- breaking
  the //// response's property type changed from no type to object for status
- breaking
  the ////// response's property type changed from no type to object for status
- breaking
  the //// response's property type changed from no type to object for status
- breaking
  the //// response's property type changed from no type to object for status
- breaking
  the ///// response's property type changed from no type to object for status
- breaking
  the ///// response's property type changed from no type to object for status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property /////// to the response with the status
- info
  added the required property /////// to the response with the status

Operation history

Get an existing workflow schedule by name

Request

Path parameters

Response 200OK

Changes

Response