People landlords
curl --request GET \
--url https://api.sortx.co.uk/people/landlords \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/people/landlords', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/people/landlords"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"rows": [
{
"contactId": "<string>",
"companyId": "<string>",
"name": "<string>",
"kind": "individual",
"properties": [
{
"propertyId": "<string>",
"label": "<string>",
"blockId": "<string>"
}
],
"canSpendMinor": 123,
"currency": "<string>",
"waitingCount": 123,
"waitingMinor": 123,
"complianceIssues": 123,
"prefers": "whatsapp"
}
],
"kpis": {
"total": 123,
"companies": 123,
"individuals": 123,
"waitingLandlords": 123,
"waitingMinor": 123,
"currency": "<string>",
"withComplianceIssue": 123
},
"counts": {
"all": 123,
"waiting": 123,
"compliance": 123,
"companies": 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>"
}people
People landlords
Landlords: what they own, what you may spend without asking, what waits on their approval and compliance
GET
/
people
/
landlords
People landlords
curl --request GET \
--url https://api.sortx.co.uk/people/landlords \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/people/landlords', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/people/landlords"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"rows": [
{
"contactId": "<string>",
"companyId": "<string>",
"name": "<string>",
"kind": "individual",
"properties": [
{
"propertyId": "<string>",
"label": "<string>",
"blockId": "<string>"
}
],
"canSpendMinor": 123,
"currency": "<string>",
"waitingCount": 123,
"waitingMinor": 123,
"complianceIssues": 123,
"prefers": "whatsapp"
}
],
"kpis": {
"total": 123,
"companies": 123,
"individuals": 123,
"waitingLandlords": 123,
"waitingMinor": 123,
"currency": "<string>",
"withComplianceIssue": 123
},
"counts": {
"all": 123,
"waiting": 123,
"compliance": 123,
"companies": 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>"
}