Skip to main content
GET
Read routing schedule

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Query Parameters

page
integer
default:1

The page number of results to retrieve. Example: 2

limit
integer
default:20

Maximum number of schedules to retrieve in a single request. Example: 50. Default: 20. Maximum: 100

Required range: 1 <= x <= 100
name
string

Filter by schedule name, matching any part of it. Example: morning

hubId
string

Fundamental entity within an organization, serving as the central point for managing various operational components. Use Use GET /hubs endpoint to get the list of Hub IDs. Example: 634e98498ce07d29474a7e29

configurationId
string

Filter by the Configuration Profile the schedule uses. Example: 65c3a1b2c3d4e5f600000009

status
enum<string>

Filter by the outcome of the last run. Example: SKIPPED

Available options:
SUCCESS,
ONGOING,
SKIPPED,
FAILED
sortBy
enum<string>
default:createdTime

Field the result-set is sorted on. Example: name. Default: createdTime

Available options:
createdTime,
name
sortOrder
enum<string>
default:desc

Ascending or descending order for the sorting. Example: asc. Default: desc

Available options:
asc,
desc

Response

Success

status
boolean

Shows if the request was successful.

message
string

Message of API response.

routingSchedules
object

Paginated list of routing schedules. Each item carries the schedule document plus logExecuted.

dataVersion
string

Server timestamp of the response, in milliseconds.