Inbox
curl --request GET \
--url https://api.sortx.co.uk/front-desk/inbox \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/front-desk/inbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/front-desk/inbox"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"counts": {
"all": 123,
"drafted": 123,
"person": 123,
"unmatched": 123
},
"items": [
{
"id": "<string>",
"channel": "whatsapp",
"address": "<string>",
"smsThreadId": "<string>",
"at": "<string>",
"preview": "<string>",
"sender": {
"state": "confirmed",
"contact": {
"id": "<string>",
"name": "<string>"
},
"place": {
"line": "<string>",
"postcode": "<string>"
},
"tenancy": "active",
"sharing": 123,
"reasons": [
"<string>"
]
},
"intent": {
"kind": "repair_report",
"alsoComplaint": true
},
"team": "<string>",
"wantsPerson": "<string>",
"draft": {
"id": "<string>",
"body": "<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>"
}front-desk
Inbox
Every message conversation waiting for a person, with who sent it, what it is about and any drafted reply
GET
/
front-desk
/
inbox
Inbox
curl --request GET \
--url https://api.sortx.co.uk/front-desk/inbox \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/front-desk/inbox', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/front-desk/inbox"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"counts": {
"all": 123,
"drafted": 123,
"person": 123,
"unmatched": 123
},
"items": [
{
"id": "<string>",
"channel": "whatsapp",
"address": "<string>",
"smsThreadId": "<string>",
"at": "<string>",
"preview": "<string>",
"sender": {
"state": "confirmed",
"contact": {
"id": "<string>",
"name": "<string>"
},
"place": {
"line": "<string>",
"postcode": "<string>"
},
"tenancy": "active",
"sharing": 123,
"reasons": [
"<string>"
]
},
"intent": {
"kind": "repair_report",
"alsoComplaint": true
},
"team": "<string>",
"wantsPerson": "<string>",
"draft": {
"id": "<string>",
"body": "<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>"
}