Get list of schedules

GET 
/v2/schedules

Gets the list of schedules that the user created.

The endpoint supports pagination using the limit and offset parameters. It will not return more than 1000 records.

By default, the records are sorted by the createdAt field in ascending order. To sort the records in descending order, use the desc=1 parameter.

Request

Query Parameters

offset double
Number of items that should be skipped at the start. The default value is 0.

Example: 0
limit double
Maximum number of items to return. The default value as well as the maximum is 1000.

Example: 1000
desc boolean
If true or 1 then the objects are sorted by the createdAt field in descending order. By default, they are sorted in ascending order.

Example: true

Status 200

Response Headers

{
  "data": {
    "total": 1,
    "offset": 0,
    "limit": 1000,
    "desc": false,
    "count": 1,
    "items": [
      {
        "id": "asdLZtadYvn4mBZmm",
        "userId": "wRsJZtadYvn4mBZmm",
        "name": "my-schedule",
        "createdAt": "2019-12-12T07:34:14.202Z",
        "modifiedAt": "2019-12-20T06:33:11.202Z",
        "lastRunAt": "2019-04-12T07:33:10.202Z",
        "nextRunAt": "2019-04-12T07:34:10.202Z",
        "isEnabled": true,
        "isExclusive": true,
        "cronExpression": "* * * * *",
        "timezone": "UTC",
        "actions": [
          {
            "id": "ZReCs7hkdieq8ZUki",
            "type": "RUN_ACTOR",
            "actorId": "HKhKmiCMrDgu9eXeE"
          }
        ]
      }
    ]
  }
}

Schema

• data object required

  Common pagination fields for list responses.

  • total integer required

    The total number of items available across all pages.

    Possible values: >= 0

    
    Example: 1
  • offset integer required

    The starting position for this page of results.

    Possible values: >= 0

    
    Example: 0
  • limit integer required

    The maximum number of items returned per page.

    Possible values: >= 1

    
    Example: 1000
  • desc boolean required

    Whether the results are sorted in descending order.

    
    Example: false
  • count integer required

    The number of items returned in this response.

    Possible values: >= 0

    
    Example: 1
  • items object[] required

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

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

        Type of action to perform when the schedule triggers.

        Possible values: [RUN_ACTOR, RUN_ACTOR_TASK]

      • actorId string required
        Example: HKhKmiCMrDgu9eXeE

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)