Documentation

Find tutorials, guides and use case examples in the

Learning center

Get Schedule by RunId

Description

The Get Schedule by Run Ids endpoint retrieves full configuration details of the schedule associated with a specific run. This is useful for tracing which schedule initiated a given run, for auditing, reporting, or troubleshooting purposes.

Request URL

http://{controllerMachine}:{controllerPort}/api/v4/schedules/{scheduleId}/runIds/{filterBy}http://{controllerMachine}:{controllerPort}/api/v4/schedules/run/{runId}

Input parameters

Field Type Description Comment
scheduleId string Unique identifier for Schedule Must be retrieved from previous run calls
accesskey string

Access token for authentication

Passed as HTTP header 

Examples

Curl

curl -X GET \
  --header 'Accept: application/json' \
  --header 'AccessKey: Mo87Nc4qDAtzJNDb' \
  'http://{controllerMachine}:{controllerPort}/api/v4/schedules/run/9ec0ba1a-79f2-4b96-86b6-f14c635bc674'

PowerShell 

$headers = @{}

$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v4/schedules/run/9ec0ba1a-79f2-4b96-86b6-f14c635bc674"" -ContentType "application/json" -Headers $headers -Method GET

Response

Returns list of runIds:

[
  {
    "Recurring": { ... },
    "RunListSteps": [ ... ],
    "Team": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Title": "QA Team"
    },
    "RunListInfoId": "00000000-0000-0000-0000-000000000000",
    "IsEnabled": true,
    "IsScheduled": true,
    "StartDateTime": {
      "Value": "2025-04-25T08:41:41.283Z",
      "LocalDateTime": "2025-04-25T08:41:41.283Z",
      "UtcDateTime": "2025-04-25T08:41:41.283Z",
      "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": "UTC",
    "InternalVersion": 0,
    "CreatedBy": "00000000-0000-0000-0000-000000000000",
    "ModifiedBy": "00000000-0000-0000-0000-000000000000",
    "AgentConfigurationId": "00000000-0000-0000-0000-000000000000",
    "Description": "Nightly regression suite",
    "DateCreation": { ... },
    "DateModify": { ... },
    "Title": "Nightly Run",
    "Type": "ScheduleInfo",
    "Id": "587d3239-5ccb-402f-a1d1-46d907bd6eaa"
  }
]

    "$id": "1",
    "runIds": [
        "f082a297-3ec0-4310-b46e-38bf422efe43",
        "ba68f389-a324-4a21-b567-d0f00dd30911"     
}

]

 

Response object

Field Type Description Comment
Id string Unique identifier of the schedule GUID
Title string Name of the schedule e.g., “UAT Nightly”
Description string Textual description of the schedule Free text
IsEnabled boolean Schedule enabled/disabled status True | False
IsScheduled boolean Whether the schedule is recurring or ad-hoc True = Scheduled, False = AdHoc
Recurring object Configuration of recurrence rules Includes frequency, end type, monthly/weekdays/etc.
RunListSteps array Steps included in the schedule Includes agent config, conditions, step order
Team object Team associated with the schedule Contains Team ID and Title
StartDateTime object Date/time when the schedule is configured to start Value, UtcDateTime, LocalDateTime, Ticks
DateCreation object Schedule creation timestamp Same structure as StartDateTime
DateModify object Schedule last modification timestamp Same structure as StartDateTime
AlreadyRunningBehavior string Action to take if schedule is already running e.g., "queueNextRun", "skip"
AgentBusyBehavior string Behavior when agents are busy e.g., "queueNextRun"
ReserveAgentsStrategy string Agent reservation strategy e.g., "reserveAllAgentsForStepBeforeStartingStep"
IsStopIfFlowFailed boolean Whether to stop schedule on failed flows True | False
FlowFailedCount number Number of failed flows in the last run 0 or greater
IsDisableScheduleIfFlowFailed boolean Whether to disable the schedule after failures True | False
FlowFailedCountToDisableSchedule number Threshold of failures before disabling 0 or greater
IsEnabledReTryPolicy boolean Retry policy enabled flag True | False
ReTryPolicyType string Retry policy type e.g., "none", "immediate", "delayed"
CountOfReTryFlowIfFailed number Number of retry attempts for failed flows 0 or greater
TimeZoneId string Time zone of the schedule e.g., "UTC", "Europe/Copenhagen"
TimeZoneOffset number Offset from UTC in minutes 0 = UTC
InternalVersion number Internal versioning field Incremented on schedule update
RevisionTimestamp number Schedule last revision marker Ticks value (timestamp)
AgentConfigurationId string ID of the agent config used GUID
RunListInfoId string ID of the run list definition 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