Block compliance profiles
curl --request GET \
--url https://api.sortx.co.uk/compliance/block-profiles \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/block-profiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/block-profiles"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"blockId": "<string>",
"facts": {
"storeyOver11m": "unknown",
"builtBefore2000": "unknown",
"fireAlarm": "unknown",
"emergencyLighting": "unknown",
"communalWater": "unknown"
},
"revision": 0,
"policyVersion": "<string>",
"updatedAt": "<string>",
"updatedByUserId": "<string>",
"ownFacts": {
"storeyOver11m": "unknown",
"builtBefore2000": "unknown",
"fireAlarm": "unknown",
"emergencyLighting": "unknown",
"communalWater": "unknown"
},
"factSources": {
"storeyOver11m": "own",
"builtBefore2000": "own",
"fireAlarm": "own",
"emergencyLighting": "own",
"communalWater": "own"
},
"history": [
{
"id": "<string>",
"kind": "<string>",
"detail": "<string>",
"actorUserId": "<string>",
"policyVersion": "<string>",
"createdAt": "<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
Block compliance profiles
Every block’s recorded communal compliance facts; a block not listed has nothing recorded
GET
/
compliance
/
block-profiles
Block compliance profiles
curl --request GET \
--url https://api.sortx.co.uk/compliance/block-profiles \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/block-profiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/block-profiles"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"blockId": "<string>",
"facts": {
"storeyOver11m": "unknown",
"builtBefore2000": "unknown",
"fireAlarm": "unknown",
"emergencyLighting": "unknown",
"communalWater": "unknown"
},
"revision": 0,
"policyVersion": "<string>",
"updatedAt": "<string>",
"updatedByUserId": "<string>",
"ownFacts": {
"storeyOver11m": "unknown",
"builtBefore2000": "unknown",
"fireAlarm": "unknown",
"emergencyLighting": "unknown",
"communalWater": "unknown"
},
"factSources": {
"storeyOver11m": "own",
"builtBefore2000": "own",
"fireAlarm": "own",
"emergencyLighting": "own",
"communalWater": "own"
},
"history": [
{
"id": "<string>",
"kind": "<string>",
"detail": "<string>",
"actorUserId": "<string>",
"policyVersion": "<string>",
"createdAt": "<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>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.
Response
Success
Show child attributes
Show child attributes
Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes