Get schedules
curl --request POST \
--url https://api2.rhombussystems.com/api/schedule/getSchedules \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/schedule/getSchedules"
payload = {}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api2.rhombussystems.com/api/schedule/getSchedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/schedule/getSchedules")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"absoluteSchedules": [
{
"intervalList": [
{
"b": 123,
"e": 123
}
],
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"error": true,
"errorMsg": "<string>",
"relativeDatetimeSchedules": [
{
"intervals": [
{
"localEndDateTime": "<string>",
"localStartDateTime": "<string>"
}
],
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"relativeSchedules": [
{
"pastSeconds": 123,
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>",
"weeklySchedules": [
{
"intervalList": [
{
"minuteOfWeekStart": 123,
"minuteOfWeekStop": 123
}
],
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
]
}Schedule Webservice
Get schedules
Get schedules in org
POST
/
api
/
schedule
/
getSchedules
Get schedules
curl --request POST \
--url https://api2.rhombussystems.com/api/schedule/getSchedules \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/schedule/getSchedules"
payload = {}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://api2.rhombussystems.com/api/schedule/getSchedules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/schedule/getSchedules")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"absoluteSchedules": [
{
"intervalList": [
{
"b": 123,
"e": 123
}
],
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"error": true,
"errorMsg": "<string>",
"relativeDatetimeSchedules": [
{
"intervals": [
{
"localEndDateTime": "<string>",
"localStartDateTime": "<string>"
}
],
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"relativeSchedules": [
{
"pastSeconds": 123,
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>",
"weeklySchedules": [
{
"intervalList": [
{
"minuteOfWeekStart": 123,
"minuteOfWeekStop": 123
}
],
"internalWriteOnly": true,
"mutable": true,
"name": "<string>",
"oneTimeUse": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"strategy": "WEEKLY_REPEATING_MINUTES",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
]
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
Available options:
api-token, api, partner-api-token, partner-api Body
application/json
Request object for getting all schedules.
Response
200 - application/json
OK
Response object for getting all schedules.
List of absolute schedules
Show child attributes
Show child attributes
List of relative datetime intervals schedules
Show child attributes
Show child attributes
List of relative schedules
Show child attributes
Show child attributes
List of weekly repeating schedules
Show child attributes
Show child attributes
Last modified on October 5, 2026