Desk call context
curl --request GET \
--url https://api.sortx.co.uk/maintenance-pro/desk-calls/{id}/context \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/desk-calls/{id}/context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/desk-calls/{id}/context"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"caller": {
"contactId": "<string>",
"name": "<string>",
"address": "<string>",
"mobile": "<string>",
"email": "<string>",
"activeTenancy": true,
"prefers": "<string>",
"preferredChannel": "<string>"
},
"matches": [
{
"contactId": "<string>",
"name": "<string>",
"address": "<string>",
"propertyId": "<string>"
}
],
"property": {
"id": "<string>",
"unitId": "<string>",
"line1": "<string>",
"address": "<string>",
"landlord": {
"contactId": "<string>",
"name": "<string>",
"mobile": "<string>"
},
"management": "<string>",
"currency": "<string>",
"spendLimitMinor": 123,
"emergencyLimitMinor": 123,
"landlordNote": "<string>",
"gasCertExpiresOn": "<string>",
"othersIn": [
"<string>"
]
},
"contractors": [
{
"contactId": "<string>",
"name": "<string>",
"trades": [
"<string>"
],
"availability": "<string>"
}
],
"openRepairs": [
{
"id": "<string>",
"reference": "<string>",
"title": "<string>",
"status": "<string>",
"urgency": "<string>",
"line": "<string>",
"contractor": "<string>",
"scheduledFor": "<string>",
"reporterContactId": "<string>",
"reportedAt": "<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>"
}maintenance-pro
Desk call context
Who is calling and about where: the caller, the property’s landlord, limits and certificates, and the repairs open there
GET
/
maintenance-pro
/
desk-calls
/
{id}
/
context
Desk call context
curl --request GET \
--url https://api.sortx.co.uk/maintenance-pro/desk-calls/{id}/context \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/maintenance-pro/desk-calls/{id}/context', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/maintenance-pro/desk-calls/{id}/context"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"caller": {
"contactId": "<string>",
"name": "<string>",
"address": "<string>",
"mobile": "<string>",
"email": "<string>",
"activeTenancy": true,
"prefers": "<string>",
"preferredChannel": "<string>"
},
"matches": [
{
"contactId": "<string>",
"name": "<string>",
"address": "<string>",
"propertyId": "<string>"
}
],
"property": {
"id": "<string>",
"unitId": "<string>",
"line1": "<string>",
"address": "<string>",
"landlord": {
"contactId": "<string>",
"name": "<string>",
"mobile": "<string>"
},
"management": "<string>",
"currency": "<string>",
"spendLimitMinor": 123,
"emergencyLimitMinor": 123,
"landlordNote": "<string>",
"gasCertExpiresOn": "<string>",
"othersIn": [
"<string>"
]
},
"contractors": [
{
"contactId": "<string>",
"name": "<string>",
"trades": [
"<string>"
],
"availability": "<string>"
}
],
"openRepairs": [
{
"id": "<string>",
"reference": "<string>",
"title": "<string>",
"status": "<string>",
"urgency": "<string>",
"line": "<string>",
"contractor": "<string>",
"scheduledFor": "<string>",
"reporterContactId": "<string>",
"reportedAt": "<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
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.