Programmes
curl --request GET \
--url https://api.sortx.co.uk/planned-maintenance/programmes \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/planned-maintenance/programmes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/planned-maintenance/programmes"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "<string>",
"reference": "<string>",
"name": "<string>",
"status": "active",
"templateId": "<string>",
"templateName": "<string>",
"serviceCategory": "<string>",
"assetClass": "<string>",
"eventType": "<string>",
"statutory": true,
"instructions": "<string>",
"propertyId": "<string>",
"propertyLabel": "<string>",
"blockId": "<string>",
"blockLabel": "<string>",
"assetId": "<string>",
"assetLabel": "<string>",
"complianceKind": "gas_safety",
"recurrenceInterval": 123,
"recurrenceUnit": "day",
"anchorDay": 123,
"instructionLeadDays": 123,
"nextDueOn": "<string>",
"overdue": true,
"jobCategory": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"autoInstruct": true,
"autoInstructSetAt": "<string>",
"responsibleTeamId": "<string>",
"responsibleTeamName": "<string>",
"managerStaffId": "<string>",
"managerName": "<string>",
"costCodeId": "<string>",
"costCodeLabel": "<string>",
"notes": "<string>",
"liveEventId": "<string>",
"liveEventStatus": "due",
"liveEventReviewState": "pending",
"endedAt": "<string>",
"endReason": "<string>",
"revision": 123,
"createdByUserId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"counts": {
"active": 123,
"ended": 123,
"overdue": 123
}
}{
"_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>"
}planned-maintenance
Programmes
Planned-maintenance programmes with their live occurrence, and the workspace’s counts
GET
/
planned-maintenance
/
programmes
Programmes
curl --request GET \
--url https://api.sortx.co.uk/planned-maintenance/programmes \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/planned-maintenance/programmes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/planned-maintenance/programmes"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"id": "<string>",
"reference": "<string>",
"name": "<string>",
"status": "active",
"templateId": "<string>",
"templateName": "<string>",
"serviceCategory": "<string>",
"assetClass": "<string>",
"eventType": "<string>",
"statutory": true,
"instructions": "<string>",
"propertyId": "<string>",
"propertyLabel": "<string>",
"blockId": "<string>",
"blockLabel": "<string>",
"assetId": "<string>",
"assetLabel": "<string>",
"complianceKind": "gas_safety",
"recurrenceInterval": 123,
"recurrenceUnit": "day",
"anchorDay": 123,
"instructionLeadDays": 123,
"nextDueOn": "<string>",
"overdue": true,
"jobCategory": "<string>",
"contractorContactId": "<string>",
"contractorName": "<string>",
"autoInstruct": true,
"autoInstructSetAt": "<string>",
"responsibleTeamId": "<string>",
"responsibleTeamName": "<string>",
"managerStaffId": "<string>",
"managerName": "<string>",
"costCodeId": "<string>",
"costCodeLabel": "<string>",
"notes": "<string>",
"liveEventId": "<string>",
"liveEventStatus": "due",
"liveEventReviewState": "pending",
"endedAt": "<string>",
"endReason": "<string>",
"revision": 123,
"createdByUserId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"counts": {
"active": 123,
"ended": 123,
"overdue": 123
}
}{
"_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.