Licence applications
curl --request GET \
--url https://api.sortx.co.uk/compliance/licence-applications \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/licence-applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/licence-applications"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"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
}
]{
"_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
Licence applications
Every open property licence application
GET
/
compliance
/
licence-applications
Licence applications
curl --request GET \
--url https://api.sortx.co.uk/compliance/licence-applications \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/licence-applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/licence-applications"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"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
}
]{
"_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