Documentation

Find tutorials, guides and use case examples in the

Learning center

Get Schedule by Name

Description

Get Schedule by Schedule Name retrieves schedule details by using the schedule's name as a search key.

It supports both exact name matching and partial matching using wildcards (%), offering flexible filtering capabilities for identifying schedules based on naming patterns.

This endpoint is useful when the schedule ID is unknown, but the user has a reference to the schedule name from naming conventions or metadata.

Request URL

http://{controllerMachine}:{controllerPort}/api/v4/schedules/{scheduleName}

Exact match: Use the full name of the schedule (e.g., ReleaseSmokeTest)

Partial match: Use % as a wildcard (e.g., Release%, %SmokeTest)

Input parameters

Property Type Description Comments
scheduleName string Name or partial name of the schedule % can be used as a wildcard for flexible filtering
accessKey string Access token for authentication Sent as an HTTP header: AccessKey: {your-token}

Examples

Curl - Exact Match

curl -X GET \
  --header 'Accept: application/json' \
  --header 'AccessKey: Mo87Nc4qDAtzJNDb' \
  'http://{controllerMachine}:{controllerPort}/api/v4/schedules/UAT'

Curl - Partial Match with Wildcard

curl -X GET \
  --header 'Accept: application/json' \
  --header 'AccessKey: Mo87Nc4qDAtzJNDb' \
  'http://{controllerMachine}:{controllerPort}/api/v4/schedules/UAT%'

PowerShell 

$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/schedules/UAT" `
  -ContentType "application/json" `
  -Headers $headers `
  -Method GET

Response

Details of a schedule will be returned as this response:

[
 {
 "Recurring": {
 "Id": "00000000-0000-0000-0000-000000000000",
 "ScheduleInfoId": "00000000-0000-0000-0000-000000000000",
 "Type": "disable",
 "Period": 0,
 "EndType": "noEnd",
 "EndDateTime": "2025-04-25T05:01:00.320Z",
 "RunsToEnd": 0,
 "EveryMonth": {
 "Id": "00000000-0000-0000-0000-000000000000",
 "ScheduleRecurringId": "00000000-0000-0000-0000-000000000000",
 "UseExactDayOfMonth": true,
 "ExactDayOfMonthNumber": 0,
 "SpecificDayType": "first",
 "SpecificDayUnit": "monday"
 },
 "EveryWeek": {
 "Id": "00000000-0000-0000-0000-000000000000",
 "ScheduleRecurringId": "00000000-0000-0000-0000-000000000000",
 "Monday": true,
 "Tuesday": true,
 "Wednesday": true,
 "Thursday": true,
 "Friday": true,
 "Saturday": true,
 "Sunday": true
 },
 "EveryDay": {
 "Id": "00000000-0000-0000-0000-000000000000",
 "ScheduleRecurringId": "00000000-0000-0000-0000-000000000000",
 "SkipWeekends": true
 },
 "EverySmallUnitOfTime": {
 "Id": "00000000-0000-0000-0000-000000000000",
 "ScheduleRecurringId": "00000000-0000-0000-0000-000000000000",
 "EveryDay": true,
 "Delay": 0
 }
},
 "RunListSteps": [
 {
 "Id": "00000000-0000-0000-0000-000000000000",
 "RunListStepId": "00000000-0000-0000-0000-000000000000",
 "ScheduleInfoId": "00000000-0000-0000-0000-000000000000",
 "StepIndex": 0,
 "StepName": "string",
 "StepStartCondition": "always",
 "EnvironmentParallelization": "runAllFlows",
 "StartOrder": "defined",
 "Agents": [
 {
 "AgentId": "00000000-0000-0000-0000-000000000000",
 "AgentTitle": "string",
 "ConnectionType": "remoteAgent"
 }
]
}
],
 "Team": {
 "Id": "00000000-0000-0000-0000-000000000000",
 "Title": "string"
 },
 "RunListInfoId": "00000000-0000-0000-0000-000000000000",
 "IsEnabled": true,
 "IsScheduled": true,
 "StartDateTime": {
 "Value": "2025-04-25T05:01:00.320Z",
 "LocalDateTime": "2025-04-25T05:01:00.320Z",
 "UtcDateTime": "2025-04-25T05:01:00.320Z",
 "Ticks": 0
 },
 "AlreadyRunningBehavior": "queueNextRun",
 "AgentBusyBehavior": "queueNextRun",
 "ReserveAgentsStrategy": "reserveAllAgentsForStepBeforeStartingStep",
 "IsStopIfFlowFailed": true,
 "FlowFailedCount": 0,
 "IsDisableScheduleIfFlowFailed": true,
 "FlowFailedCountToDisableSchedule": 0,
 "IsEnabledReTryPolicy": true,
 "ReTryPolicyType": "none",
 "CountOfReTryFlowIfFailed": 0,
 "IsStopIfLateness": true,
 "EstimatedRunTimePrecision": 0,
 "IsStopAfterElapsedInterval": true,
 "StopIntervalMinutes": 0,
 "RevisionTimestamp": 0,
 "TimeZoneOffset": 0,
 "TimeZoneId": "string",
 "InternalVersion": 0,
 "CreatedBy": "00000000-0000-0000-0000-000000000000",
 "ModifiedBy": "00000000-0000-0000-0000-000000000000",
 "AgentConfigurationId": "00000000-0000-0000-0000-000000000000",
 "Description": "string",
 "DateCreation": {
 "Value": "2025-04-25T05:01:00.320Z",
 "LocalDateTime": "2025-04-25T05:01:00.320Z",
 "UtcDateTime": "2025-04-25T05:01:00.320Z",
 "Ticks": 0
 },
 "DateModify": {
 "Value": "2025-04-25T05:01:00.320Z",
 "LocalDateTime": "2025-04-25T05:01:00.320Z",
 "UtcDateTime": "2025-04-25T05:01:00.320Z",
 "Ticks": 0
 },
 "Title": "string",
 "Type": "folder",
 "Id": "00000000-0000-0000-0000-000000000000"
 }
]
 

 

Response object

Field Type Description Values
Recurring object Schedule recurrence configuration Includes Type, Period, EndType, EveryMonth, etc.
RunListSteps array Steps included in the schedule Includes agents, step index, conditions
Team object Team assigned to the schedule Id, Title
StartDateTime object Date/time when the schedule begins Value, LocalDateTime, Ticks
EstimatedRunTimePrecision number Expected run-time precision in seconds Numeric
IsStopAfterElapsedInterval boolean Stop execution after max interval True | False
StopIntervalMinutes number Time in minutes before stopping Numeric
RevisionTimestamp number Schedule versioning value Ticks format (numeric)
TimeZoneOffset number Offset from UTC e.g. 0 = UTC, 120 = GMT+2
CreatedBy string User who created the schedule GUID
ModifiedBy string User who last modified the schedule GUID
AgentConfigurationId string  Agent configuration profile GUID
RunListInfoId string Identifier for the run list GUID
Description string Textual description of the schedule Free text
IsEnabled boolean Is schedule Enabled/Disable status True | False
IsScheduled boolean Schedule type:
True: Scheduled
False: AdHoc		 True | False
DayOfWeek string Days of week the schedule runs on (if recurring) 'Monday', 'Tuesday', ..., 'EveryDay'
DailyWindowPeriodEnd string End time for the daily execution window HH:mm:ss
DailyWindowPeriodStart string Start time for the daily execution window HH:mm:ss
Repeat string Repeat mode of the schedule

'NoRepeat', 'RepeatEvery', 'StartRightAfterLastRun'
RepeatMinutes number Minutes between runs when repeat mode is 'RepeatEvery' Any positive number
AlreadyRunningBehavior string What to do if a run is already in progress 'queueNextRun', 'skip'
AgentBusyBehavior string What to do if agents are busy 'queueNextRun', 'skip'
ReserveAgentsStrategy string Agent reservation policy 'reserveAllAgentsForStepBeforeStartingStep'
IsStopIfFlowFailed boolean Stop the schedule if any flow fails True | False
FlowFailedCount number Number of failed flows in the last run 0 or greater
IsDisableScheduleIfFlowFailed boolean Whether to disable the schedule after repeated failures True | False
FlowFailedCountToDisableSchedule number Threshold of failures before schedule gets disabled 0 or greater
IsEnabledReTryPolicy boolean Whether retry policy is enabled True | False
ReTryPolicyType string Type of retry policy 'none', 'immediate', 'delayed'
CountOfReTryFlowIfFailed number Number of retry attempts for failed flows 0 or greater
TimeZoneId string Time zone in which the schedule is configured e.g. 'UTC', 'Europe/Copenhagen'
Title string Name of the schedule e.g. 'UAT Nightly'
Type string Type of object 'ScheduleInfo' or 'folder'
Id string Unique ID of the schedule GUID

Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)

Product
Company
  • Our story
  • Leadership
  • Customers
  • Blog
  • Events and webinars
  • Resource hub
  • Careers We're hiring!
  • News
  • Legal
    • Support
  • Knowledge base
  • Documentation
  • Technical support
    • Contact

    Americas

    info-americas@leapwork.com

    +1 415 237 1060


    EMEA

    info-emea@leapwork.com

    +45 35 25 14 14

    ©2024, Leapwork. All rights reserved.

    Cookie preferences | Impressum