Property boards record
curl --request GET \
--url https://api.sortx.co.uk/property-boards/properties/{propertyId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/properties/{propertyId}', 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/properties/{propertyId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"property": {
"propertyId": "<string>",
"address": "<string>",
"line1": "<string>",
"postcode": "<string>",
"typeLine": "<string>",
"hmo": true,
"blockId": "<string>",
"blockName": "<string>",
"archivedAt": "<string>",
"archiveReason": "sold",
"occupancy": "let",
"occupancyLabel": "<string>"
},
"landlord": {
"contactId": "<string>",
"name": "<string>"
},
"occupier": {
"contactId": "<string>",
"tenancyId": "<string>",
"name": "<string>"
},
"certificates": [
{
"kind": "gas_safety",
"name": "<string>",
"tone": "ok",
"state": "<string>",
"detail": "<string>",
"documentId": "<string>",
"repair": {
"repairId": "<string>",
"reference": "<string>"
}
}
],
"repairs": [
{
"repairId": "<string>",
"reference": "<string>",
"issue": "<string>",
"when": "<string>",
"status": "<string>",
"tone": "blue",
"open": true
}
],
"inspections": [
{
"inspectionId": "<string>",
"reference": "<string>",
"on": "<string>",
"date": "<string>",
"type": "<string>",
"detail": "<string>",
"status": "<string>",
"tone": "blue"
}
],
"keys": [
{
"keySetId": "<string>",
"set": "<string>",
"reference": "<string>",
"status": "in_office",
"where": "<string>",
"tone": "ok",
"detail": "<string>"
}
],
"accessNotes": "<string>",
"complaints": [
{
"complaintId": "<string>",
"number": 123,
"summary": "<string>",
"status": "<string>",
"open": true,
"receivedOn": "<string>"
}
],
"counts": {
"compliance": 123,
"repairs": 123,
"inspections": 123,
"complaints": 123,
"keys": 123
},
"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 record
One property’s record: its five certificates, repairs, inspections, keys, access notes, complaints and tab counts
GET
/
property-boards
/
properties
/
{propertyId}
Property boards record
curl --request GET \
--url https://api.sortx.co.uk/property-boards/properties/{propertyId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/property-boards/properties/{propertyId}', 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/properties/{propertyId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"property": {
"propertyId": "<string>",
"address": "<string>",
"line1": "<string>",
"postcode": "<string>",
"typeLine": "<string>",
"hmo": true,
"blockId": "<string>",
"blockName": "<string>",
"archivedAt": "<string>",
"archiveReason": "sold",
"occupancy": "let",
"occupancyLabel": "<string>"
},
"landlord": {
"contactId": "<string>",
"name": "<string>"
},
"occupier": {
"contactId": "<string>",
"tenancyId": "<string>",
"name": "<string>"
},
"certificates": [
{
"kind": "gas_safety",
"name": "<string>",
"tone": "ok",
"state": "<string>",
"detail": "<string>",
"documentId": "<string>",
"repair": {
"repairId": "<string>",
"reference": "<string>"
}
}
],
"repairs": [
{
"repairId": "<string>",
"reference": "<string>",
"issue": "<string>",
"when": "<string>",
"status": "<string>",
"tone": "blue",
"open": true
}
],
"inspections": [
{
"inspectionId": "<string>",
"reference": "<string>",
"on": "<string>",
"date": "<string>",
"type": "<string>",
"detail": "<string>",
"status": "<string>",
"tone": "blue"
}
],
"keys": [
{
"keySetId": "<string>",
"set": "<string>",
"reference": "<string>",
"status": "in_office",
"where": "<string>",
"tone": "ok",
"detail": "<string>"
}
],
"accessNotes": "<string>",
"complaints": [
{
"complaintId": "<string>",
"number": 123,
"summary": "<string>",
"status": "<string>",
"open": true,
"receivedOn": "<string>"
}
],
"counts": {
"compliance": 123,
"repairs": 123,
"inspections": 123,
"complaints": 123,
"keys": 123
},
"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