Get schedule

GET 
/v2/schedules/:scheduleId

Gets the schedule object with all details.

Request

Path Parameters

scheduleId string required
Schedule ID.

Example: asdLZtadYvn4mBZmm

Status 200

Response Headers

{
  "data": {
    "id": "asdLZtadYvn4mBZmm",
    "userId": "wRsJZtadYvn4mBZmm",
    "name": "my-schedule",
    "cronExpression": "* * * * *",
    "timezone": "UTC",
    "isEnabled": true,
    "isExclusive": true,
    "description": "Schedule of actor ...",
    "createdAt": "2019-12-12T07:34:14.202Z",
    "modifiedAt": "2019-12-20T06:33:11.202Z",
    "nextRunAt": "2019-04-12T07:34:10.202Z",
    "lastRunAt": "2019-04-12T07:33:10.202Z",
    "actions": [
      {
        "id": "c6KfSgoQzFhMk3etc",
        "type": "RUN_ACTOR",
        "actorId": "jF8GGEvbEg4Au3NLA",
        "runInput": {
          "body": "{\\n   \"foo\": \"actor\"\\n}",
          "contentType": "application/json; charset=utf-8"
        },
        "runOptions": {
          "build": "latest",
          "timeoutSecs": 60,
          "memoryMbytes": 1024,
          "restartOnError": false
        }
      }
    ]
  }
}

Schema

• data object required

  • id string required
    Example: asdLZtadYvn4mBZmm
  • userId string required
    Example: wRsJZtadYvn4mBZmm
  • name string required
    Example: my-schedule
  • cronExpression string required
    Example: * * * * *
  • timezone string required
    Example: UTC
  • isEnabled boolean required
    Example: true
  • isExclusive boolean required
    Example: true
  • description string | null nullable
    Example: Schedule of actor ...
  • createdAt string<date-time> required
    Example: 2019-12-12T07:34:14.202Z
  • modifiedAt string<date-time> required
    Example: 2019-12-20T06:33:11.202Z
  • nextRunAt string,null<date-time> nullable
    Example: 2019-04-12T07:34:10.202Z
  • lastRunAt string,null<date-time> nullable
    Example: 2019-04-12T07:33:10.202Z
  • actions object[] required

    • id string required
      Example: c6KfSgoQzFhMk3etc
    • type ScheduleActionType (string) required

      Type of action to perform when the schedule triggers.

      Possible values: [RUN_ACTOR, RUN_ACTOR_TASK]

    • actorId string required
      Example: jF8GGEvbEg4Au3NLA
    • runInput object

      anyOf
      • ScheduleActionsRunInput
      • null
      body string | null nullable
      Example: {\n "foo": "actor"\n}
      contentType string | null nullable
      Example: application/json; charset=utf-8
    • runOptions object

      anyOf
      • ScheduleActionsRunOptions
      • null
      build string | null nullable
      Example: latest
      timeoutSecs integer | null nullable
      Example: 60
      memoryMbytes integer | null nullable
      Example: 1024
      restartOnError boolean | null nullable
      Example: false

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)