List Schedules
GET {{baseUrl}}/api/schedules
Get a list of all schedules that the authenticated user has access to. This endpoint returns the name, ID, and other information about schedules. You obtain the authorization token needed to execute the request using POST /auth/login. You pass the authorization token in the request header.
Body
PARAM
Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token |
RESPONSES
status OK
{
"schedules": [
{
"name": "All the Time",
"id": "FF7BB3C811D501F0C00051916B98494F",
"description": "Starts Friday, January 01, 2010 and ends Sunday, May 30, 2010. The schedule will be triggered every day. 1 hours, 0 minutes",
"scheduleType": "time_based",
"scheduleNextDelivery": "2022-03-21T21:00:00+0000",
"startDate": "2009-12-31",
"time": {
"recurrencePattern": "daily",
"execution": {
"executionPattern": "repeat",
"startTime": "00:00:00",
"stopTime": "23:59:00",
"repeatInterval": 60
},
"daily": {
"dailyPattern": "day",
"repeatInterval": 1
}
},
"expired": false,
"acg": 255
},
{
"name": "At Close of Business (Weekday)",
"id": "FF7BB3BC11D501F0C00051916B98494F",
"description": "Starts Wednesday, February 14, 2001 and has no end. The schedule will be triggered every weekday. It runs at 6:00:00 PM",
"scheduleType": "time_based",
"scheduleNextDelivery": "2022-03-22T18:00:00+0000",
"startDate": "2001-02-14",
"time": {
"recurrencePattern": "weekly",
"execution": {
"executionPattern": "once",
"executionTime": "18:00:00"
},
"weekly": {
"repeatInterval": 1,
"daysOfWeek": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
]
}
},
"expired": false,
"acg": 255
}
]
} |
ENDPOINTS