People landlord
curl --request GET \
--url https://api.sortx.co.uk/people/landlords/{contactId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/people/landlords/{contactId}', 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/{contactId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"contactId": "<string>",
"companyId": "<string>",
"name": "<string>",
"kind": "individual",
"email": "<string>",
"mobile": "<string>",
"prefers": "whatsapp",
"canSpend": {
"limitMinor": 123,
"currency": "<string>",
"emergencyShort": "<string>"
},
"waiting": {
"count": 123,
"totalMinor": 123,
"currency": "<string>",
"remindedAt": "<string>"
},
"pending": [
{
"approvalId": "<string>",
"repairId": "<string>",
"reference": "<string>",
"title": "<string>",
"propertyId": "<string>",
"propertyLine": "<string>",
"contractorName": "<string>",
"note": "<string>",
"amountMinor": 123,
"currency": "<string>",
"sentAt": "<string>",
"remindedAt": "<string>",
"timeline": [
{
"kind": "sent",
"at": "<string>",
"state": "done",
"channels": [
"<string>"
]
}
]
}
],
"properties": [
{
"propertyId": "<string>",
"label": "<string>",
"description": "<string>",
"status": "let",
"emptySince": "<string>",
"compliance": {
"issues": 123,
"line": "<string>"
},
"repairs": {
"open": 123,
"waitingApproval": 123,
"line": "<string>"
}
}
],
"works": {
"from": "<string>",
"totalMinor": 123,
"currency": "<string>",
"jobs": 123,
"propertyCount": 123,
"rows": [
{
"repairId": "<string>",
"doneOn": "<string>",
"title": "<string>",
"propertyId": "<string>",
"propertyLine": "<string>",
"contractorName": "<string>",
"amountMinor": 123
}
]
},
"preferences": {
"approvalMethod": "email_link",
"invoiceRoute": "from_rent",
"lines": [
{
"key": "<string>",
"label": "<string>",
"value": "<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>"
}people
People landlord
One landlord: spending limit and emergency rule, what waits on them, their properties, works this financial year and how they like to work
GET
/
people
/
landlords
/
{contactId}
People landlord
curl --request GET \
--url https://api.sortx.co.uk/people/landlords/{contactId} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/people/landlords/{contactId}', 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/{contactId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"contactId": "<string>",
"companyId": "<string>",
"name": "<string>",
"kind": "individual",
"email": "<string>",
"mobile": "<string>",
"prefers": "whatsapp",
"canSpend": {
"limitMinor": 123,
"currency": "<string>",
"emergencyShort": "<string>"
},
"waiting": {
"count": 123,
"totalMinor": 123,
"currency": "<string>",
"remindedAt": "<string>"
},
"pending": [
{
"approvalId": "<string>",
"repairId": "<string>",
"reference": "<string>",
"title": "<string>",
"propertyId": "<string>",
"propertyLine": "<string>",
"contractorName": "<string>",
"note": "<string>",
"amountMinor": 123,
"currency": "<string>",
"sentAt": "<string>",
"remindedAt": "<string>",
"timeline": [
{
"kind": "sent",
"at": "<string>",
"state": "done",
"channels": [
"<string>"
]
}
]
}
],
"properties": [
{
"propertyId": "<string>",
"label": "<string>",
"description": "<string>",
"status": "let",
"emptySince": "<string>",
"compliance": {
"issues": 123,
"line": "<string>"
},
"repairs": {
"open": 123,
"waitingApproval": 123,
"line": "<string>"
}
}
],
"works": {
"from": "<string>",
"totalMinor": 123,
"currency": "<string>",
"jobs": 123,
"propertyCount": 123,
"rows": [
{
"repairId": "<string>",
"doneOn": "<string>",
"title": "<string>",
"propertyId": "<string>",
"propertyLine": "<string>",
"contractorName": "<string>",
"amountMinor": 123
}
]
},
"preferences": {
"approvalMethod": "email_link",
"invoiceRoute": "from_rent",
"lines": [
{
"key": "<string>",
"label": "<string>",
"value": "<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