People tenants
curl --request GET \
--url https://api.sortx.co.uk/people/tenants \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/people/tenants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/people/tenants"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"rows": [
{
"contactId": "<string>",
"name": "<string>",
"tenancyId": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"place": "<string>",
"channel": "whatsapp",
"goodToKnow": "<string>",
"openRepairs": 123,
"lastContactAt": "<string>",
"access": "<string>",
"accessNeeded": {
"reason": "<string>",
"source": "no_access_visit"
}
}
],
"counts": {
"all": 123,
"open_repairs": 123,
"good_to_know": 123,
"access_needed": 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 tenants
The people living in your properties: how to reach them, what to know, open repairs, last contact and access
GET
/
people
/
tenants
People tenants
curl --request GET \
--url https://api.sortx.co.uk/people/tenants \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/people/tenants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/people/tenants"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"rows": [
{
"contactId": "<string>",
"name": "<string>",
"tenancyId": "<string>",
"propertyId": "<string>",
"unitId": "<string>",
"place": "<string>",
"channel": "whatsapp",
"goodToKnow": "<string>",
"openRepairs": 123,
"lastContactAt": "<string>",
"access": "<string>",
"accessNeeded": {
"reason": "<string>",
"source": "no_access_visit"
}
}
],
"counts": {
"all": 123,
"open_repairs": 123,
"good_to_know": 123,
"access_needed": 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>"
}