API Explorer: /schedules

To return a list of test schedules, an accountId, a projectId, a workspaceId, a collectionId, OR a testId are required. The sample code returns a list for items with a workspaceId of 123456. Use the actual ID values for the project, workspace, collection, or test to return the list of test schedules.

You can return a list specifying either a projectId, a workspaceId, a collectionId, a testId, or any combination of the workspace, project, and either testId or collectionId. The returned list contains each test schedule's scheduleId (shows up as id in the response) and configuration.

List Schedules Parameters

Parameters

• workspaceId integer

  required

  The workspaceId you are wanting to get the list of test schedules for

• accountId integer

  required

  The accountId you are wanting to get the list of test schedules for

• projectId integer

  required

  The projectId you are wanting to get the list of test schedules for

• testId integer

  required

  The testId you are wanting to get the list of test schedules for

• collectionId integer

  required

  The collectionId you are wanting to get the list of test schedules for

• enabled boolean

  Denotes if you are wanting to get a list of test schedules that are enabled (if true) or disabled (if false)

Also see: Pagination and Sorting

curl 'https://a.blazemeter.com/api/v4/schedules?workspaceId=123456' \
    --user 'api_key_id:api_key_secret'

List Schedules Response Attributes

To see a breakdown of the attributes, refer to The Schedule Object section.

{
    "limit": 10,
    "skip": 0,
    "total": 2,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": "5c83e5610bd29075e16b2794",
            "cron": "0 0 * * 1-5",
            "nextRun": 1552262400,
            "enabled": false,
            "type": "testRun",
            "created": 1552147809,
            "updated": 1552150058,
            "testId": 6658400,
            "createdById": 344260,
            "lastUpdatedById": 344260
        },
        {
            "id": "5c83ec4a7b12f573685c5f36",
            "cron": "0 0 * * 1-5",
            "nextRun": 1552262400,
            "enabled": true,
            "type": "testRun",
            "created": 1552149578,
            "updated": 1552149578,
            "testCollectionId": 10027459,
            "createdById": 344260
        }
    ]
}