Out of hours
curl --request GET \
--url https://api.sortx.co.uk/maintenance-pro/out-of-hours \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/out-of-hours', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/out-of-hours"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"enabled": true,
"timeZone": "<string>",
"officeHours": {
"mon": {
"open": "<string>",
"close": "<string>"
},
"tue": {
"open": "<string>",
"close": "<string>"
},
"wed": {
"open": "<string>",
"close": "<string>"
},
"thu": {
"open": "<string>",
"close": "<string>"
},
"fri": {
"open": "<string>",
"close": "<string>"
},
"sat": {
"open": "<string>",
"close": "<string>"
},
"sun": {
"open": "<string>",
"close": "<string>"
}
},
"days": 123,
"rows": [
{
"repairId": "<string>",
"reference": "<string>",
"reportedAt": "<string>",
"property": "<string>",
"description": "<string>",
"urgency": "<string>",
"status": "<string>",
"reportedVia": "<string>",
"page": {
"repairId": "<string>",
"status": "paging",
"outOfHours": true,
"ackMinutes": 123,
"startedAt": "<string>",
"nextPageAt": "<string>",
"takenBy": "<string>",
"takenAt": "<string>",
"takenVia": "link",
"endedReason": "<string>",
"attempts": [
{
"step": 123,
"name": "<string>",
"reason": "rota",
"at": "<string>",
"sms": "queued",
"email": "sent"
}
]
}
}
],
"truncated": true,
"nowChain": [
{
"userId": "<string>",
"name": "<string>",
"reason": "rota"
}
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}maintenance-pro
Out of hours
What came in outside office hours, who was paged and who took it
GET
/
maintenance-pro
/
out-of-hours
Out of hours
curl --request GET \
--url https://api.sortx.co.uk/maintenance-pro/out-of-hours \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/out-of-hours', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/out-of-hours"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"enabled": true,
"timeZone": "<string>",
"officeHours": {
"mon": {
"open": "<string>",
"close": "<string>"
},
"tue": {
"open": "<string>",
"close": "<string>"
},
"wed": {
"open": "<string>",
"close": "<string>"
},
"thu": {
"open": "<string>",
"close": "<string>"
},
"fri": {
"open": "<string>",
"close": "<string>"
},
"sat": {
"open": "<string>",
"close": "<string>"
},
"sun": {
"open": "<string>",
"close": "<string>"
}
},
"days": 123,
"rows": [
{
"repairId": "<string>",
"reference": "<string>",
"reportedAt": "<string>",
"property": "<string>",
"description": "<string>",
"urgency": "<string>",
"status": "<string>",
"reportedVia": "<string>",
"page": {
"repairId": "<string>",
"status": "paging",
"outOfHours": true,
"ackMinutes": 123,
"startedAt": "<string>",
"nextPageAt": "<string>",
"takenBy": "<string>",
"takenAt": "<string>",
"takenVia": "link",
"endedReason": "<string>",
"attempts": [
{
"step": 123,
"name": "<string>",
"reason": "rota",
"at": "<string>",
"sms": "queued",
"email": "sent"
}
]
}
}
],
"truncated": true,
"nowChain": [
{
"userId": "<string>",
"name": "<string>",
"reason": "rota"
}
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.