Compliance board hmo
curl --request GET \
--url https://api.sortx.co.uk/compliance/boards/hmo-licences \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/boards/hmo-licences', 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/hmo-licences"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"dataAsOf": "<string>",
"kpis": [
{
"key": "<string>",
"label": "<string>",
"value": "<string>",
"valueSuffix": "<string>",
"sub": "<string>",
"tone": "ok"
}
],
"tabs": [
{
"key": "<string>",
"label": "<string>",
"count": 123
}
],
"rows": [
{
"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>"
},
"tabs": [
"<string>"
],
"status": {
"tone": "ok",
"label": "<string>"
},
"headline": {
"tone": "ok",
"label": "<string>"
},
"documentId": "<string>",
"work": {
"id": "<string>",
"subjectKind": "property",
"subjectId": "<string>",
"kind": "<string>",
"state": "booked",
"contractorContactId": "<string>",
"contractorName": "<string>",
"visitOn": "<string>",
"note": "<string>",
"openedAt": "<string>",
"openedByUserId": "<string>",
"revision": 123,
"updatedAt": "<string>"
},
"note": "<string>",
"council": "<string>",
"licenceType": "mandatory_hmo",
"licenceTypeLabel": "<string>",
"licenceNumber": "<string>",
"holderName": "<string>",
"startsOn": "<string>",
"expiresOn": "<string>",
"daysLeft": 123,
"occupants": 123,
"maxOccupants": 123,
"conditions": [
{
"id": "<string>",
"propertyId": "<string>",
"licenceDocumentId": "<string>",
"text": "<string>",
"dueOn": "<string>",
"completedOn": "<string>",
"archived": true,
"revision": 123
}
],
"openConditions": 123,
"application": {
"id": "<string>",
"propertyId": "<string>",
"kind": "new",
"licenceType": "mandatory_hmo",
"council": "<string>",
"stage": "started",
"startedOn": "<string>",
"submittedOn": "<string>",
"inspectionOn": "<string>",
"decidedOn": "<string>",
"reference": "<string>",
"feeMinor": 123,
"feePaidOn": "<string>",
"floorPlanDocumentId": "<string>",
"note": "<string>",
"open": true,
"revision": 123
},
"steps": [
{
"key": "<string>",
"label": "<string>",
"state": "done"
}
],
"documents": [
{
"key": "<string>",
"label": "<string>",
"state": "ready",
"sourceLabel": "<string>",
"sourceBoard": "overview",
"documentId": "<string>"
}
],
"documentsReady": 123,
"summary": "<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 hmo
HMO licences: licences by council, occupancy, conditions and applications
GET
/
compliance
/
boards
/
hmo-licences
Compliance board hmo
curl --request GET \
--url https://api.sortx.co.uk/compliance/boards/hmo-licences \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/boards/hmo-licences', 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/hmo-licences"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"dataAsOf": "<string>",
"kpis": [
{
"key": "<string>",
"label": "<string>",
"value": "<string>",
"valueSuffix": "<string>",
"sub": "<string>",
"tone": "ok"
}
],
"tabs": [
{
"key": "<string>",
"label": "<string>",
"count": 123
}
],
"rows": [
{
"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>"
},
"tabs": [
"<string>"
],
"status": {
"tone": "ok",
"label": "<string>"
},
"headline": {
"tone": "ok",
"label": "<string>"
},
"documentId": "<string>",
"work": {
"id": "<string>",
"subjectKind": "property",
"subjectId": "<string>",
"kind": "<string>",
"state": "booked",
"contractorContactId": "<string>",
"contractorName": "<string>",
"visitOn": "<string>",
"note": "<string>",
"openedAt": "<string>",
"openedByUserId": "<string>",
"revision": 123,
"updatedAt": "<string>"
},
"note": "<string>",
"council": "<string>",
"licenceType": "mandatory_hmo",
"licenceTypeLabel": "<string>",
"licenceNumber": "<string>",
"holderName": "<string>",
"startsOn": "<string>",
"expiresOn": "<string>",
"daysLeft": 123,
"occupants": 123,
"maxOccupants": 123,
"conditions": [
{
"id": "<string>",
"propertyId": "<string>",
"licenceDocumentId": "<string>",
"text": "<string>",
"dueOn": "<string>",
"completedOn": "<string>",
"archived": true,
"revision": 123
}
],
"openConditions": 123,
"application": {
"id": "<string>",
"propertyId": "<string>",
"kind": "new",
"licenceType": "mandatory_hmo",
"council": "<string>",
"stage": "started",
"startedOn": "<string>",
"submittedOn": "<string>",
"inspectionOn": "<string>",
"decidedOn": "<string>",
"reference": "<string>",
"feeMinor": 123,
"feePaidOn": "<string>",
"floorPlanDocumentId": "<string>",
"note": "<string>",
"open": true,
"revision": 123
},
"steps": [
{
"key": "<string>",
"label": "<string>",
"state": "done"
}
],
"documents": [
{
"key": "<string>",
"label": "<string>",
"state": "ready",
"sourceLabel": "<string>",
"sourceBoard": "overview",
"documentId": "<string>"
}
],
"documentsReady": 123,
"summary": "<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>"
}