Compliance board overview
curl --request GET \
--url https://api.sortx.co.uk/compliance/boards/overview \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/boards/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/boards/overview"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"dataAsOf": "<string>",
"description": "<string>",
"kpis": [
{
"key": "<string>",
"label": "<string>",
"value": "<string>",
"valueSuffix": "<string>",
"sub": "<string>",
"tone": "ok"
}
],
"categories": [
{
"board": "overview",
"label": "<string>",
"summary": "<string>",
"pill": {
"tone": "ok",
"label": "<string>"
},
"segments": {
"ok": 123,
"due": 123,
"bad": 123,
"missing": 123
}
}
],
"needsAction": [
{
"propertyId": "<string>",
"property": {
"propertyId": "<string>",
"name": "<string>",
"line1": "<string>",
"postcode": "<string>",
"area": "<string>",
"town": "<string>",
"place": "<string>",
"type": "<string>",
"beds": 123,
"rooms": 123,
"hmo": true,
"blockId": "<string>",
"blockName": "<string>",
"landlordContactId": "<string>",
"landlord": "<string>",
"tenants": [
"<string>"
],
"occupants": 123,
"vacant": true,
"tenancyEndsOn": "<string>",
"nextTenancyStartsOn": "<string>"
},
"board": "overview",
"kind": "<string>",
"requirement": "<string>",
"status": {
"tone": "ok",
"label": "<string>"
},
"dueOn": "<string>",
"dueLabel": "<string>",
"action": "<string>",
"primary": true,
"repairId": "<string>",
"repairReference": "<string>"
}
],
"comingUp": [
{
"on": "<string>",
"board": "overview",
"propertyId": "<string>",
"title": "<string>",
"sub": "<string>"
}
]
}{
"_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>"
}compliance
Compliance board overview
Overview: the counts, each certificate type, what needs action and what is coming up
GET
/
compliance
/
boards
/
overview
Compliance board overview
curl --request GET \
--url https://api.sortx.co.uk/compliance/boards/overview \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/boards/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/boards/overview"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"dataAsOf": "<string>",
"description": "<string>",
"kpis": [
{
"key": "<string>",
"label": "<string>",
"value": "<string>",
"valueSuffix": "<string>",
"sub": "<string>",
"tone": "ok"
}
],
"categories": [
{
"board": "overview",
"label": "<string>",
"summary": "<string>",
"pill": {
"tone": "ok",
"label": "<string>"
},
"segments": {
"ok": 123,
"due": 123,
"bad": 123,
"missing": 123
}
}
],
"needsAction": [
{
"propertyId": "<string>",
"property": {
"propertyId": "<string>",
"name": "<string>",
"line1": "<string>",
"postcode": "<string>",
"area": "<string>",
"town": "<string>",
"place": "<string>",
"type": "<string>",
"beds": 123,
"rooms": 123,
"hmo": true,
"blockId": "<string>",
"blockName": "<string>",
"landlordContactId": "<string>",
"landlord": "<string>",
"tenants": [
"<string>"
],
"occupants": 123,
"vacant": true,
"tenancyEndsOn": "<string>",
"nextTenancyStartsOn": "<string>"
},
"board": "overview",
"kind": "<string>",
"requirement": "<string>",
"status": {
"tone": "ok",
"label": "<string>"
},
"dueOn": "<string>",
"dueLabel": "<string>",
"action": "<string>",
"primary": true,
"repairId": "<string>",
"repairReference": "<string>"
}
],
"comingUp": [
{
"on": "<string>",
"board": "overview",
"propertyId": "<string>",
"title": "<string>",
"sub": "<string>"
}
]
}{
"_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>"
}