Property boards block
curl --request GET \
--url https://api.sortx.co.uk/property-boards/blocks/{blockId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/blocks/{blockId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/property-boards/blocks/{blockId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"blockId": "<string>",
"name": "<string>",
"address": "<string>",
"sharedAreas": {
"contactId": "<string>",
"name": "<string>",
"role": "managing_agent"
},
"managed": 123,
"total": 123,
"units": [
{
"propertyId": "<string>",
"name": "<string>",
"state": "let",
"label": "<string>"
}
],
"documents": [
{
"kind": "fire_risk_assessment",
"name": "<string>",
"detail": "<string>",
"state": "held",
"stateLabel": "<string>",
"action": "view",
"actionLabel": "<string>",
"documentId": "<string>",
"taskId": "<string>"
}
],
"withheld": [
"<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>"
}property-boards
Property boards block
One building: who looks after the shared areas, the flats you manage and the shared-area safety documents
GET
/
property-boards
/
blocks
/
{blockId}
Property boards block
curl --request GET \
--url https://api.sortx.co.uk/property-boards/blocks/{blockId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/blocks/{blockId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/property-boards/blocks/{blockId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"blockId": "<string>",
"name": "<string>",
"address": "<string>",
"sharedAreas": {
"contactId": "<string>",
"name": "<string>",
"role": "managing_agent"
},
"managed": 123,
"total": 123,
"units": [
{
"propertyId": "<string>",
"name": "<string>",
"state": "let",
"label": "<string>"
}
],
"documents": [
{
"kind": "fire_risk_assessment",
"name": "<string>",
"detail": "<string>",
"state": "held",
"stateLabel": "<string>",
"action": "view",
"actionLabel": "<string>",
"documentId": "<string>",
"taskId": "<string>"
}
],
"withheld": [
"<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
Response
Success