Enquiry
curl --request GET \
--url https://api.sortx.co.uk/front-desk/enquiries/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/front-desk/enquiries/{id}', 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/enquiries/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"enquiry": {
"id": "<string>",
"callId": "<string>",
"channel": "<string>",
"updatedAt": "<string>",
"whatsappThreadId": "<string>",
"contactId": "<string>",
"state": "<string>",
"intent": "<string>",
"outcome": "<string>",
"summary": "<string>",
"callerNumber": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"durationSeconds": 123,
"providerConversationId": "<string>",
"teamId": "<string>",
"smsThreadId": "<string>"
},
"whatsapp": {
"threadId": "<string>",
"connectionId": "<string>",
"consent": "<string>",
"matchState": "<string>",
"windowExpiresAt": "<string>",
"enabled": true,
"displayName": "<string>",
"messages": [
{
"id": "<string>",
"clientId": "<string>",
"direction": "<string>",
"type": "<string>",
"text": "<string>",
"status": "<string>",
"error": "<string>",
"at": "<string>",
"mediaId": "<string>",
"filename": "<string>",
"mediaStored": true,
"mediaError": "<string>"
}
],
"templates": [
{
"id": "<string>",
"name": "<string>",
"language": "<string>",
"category": "<string>",
"status": "<string>",
"qualityRating": "<string>",
"rejectionReason": "<string>",
"body": "<string>",
"parameterCount": 123,
"supported": true,
"unsupportedReason": "<string>",
"lastSyncedAt": "<string>"
}
]
},
"transcript": [
{
"sequence": 123,
"role": "<string>",
"text": "<string>",
"at": "<string>"
}
],
"answers": [
{
"questionKey": "<string>",
"answer": "<string>"
}
],
"escalations": [
{
"id": "<string>",
"reason": "<string>",
"smsOutboxId": 123,
"taskId": "<string>",
"createdAt": "<string>"
}
],
"outcomes": [
{
"id": "<string>",
"enquiryId": "<string>",
"kind": "<string>",
"state": "<string>",
"payload": {},
"contactId": "<string>",
"propertyId": "<string>",
"summary": "<string>",
"acknowledgedByUserId": "<string>",
"acknowledgedAt": "<string>",
"note": "<string>",
"linkedKind": "<string>",
"linkedId": "<string>",
"createdAt": "<string>"
}
],
"outcomeChecks": [
{
"id": "<string>",
"status": "verified",
"reasons": [
{
"code": "<string>",
"detail": "<string>"
}
],
"assessmentIds": [
"<string>"
],
"model": "<string>",
"taskId": "<string>",
"createdAt": "<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
Enquiry
Read one enquiry with its transcript, answers and escalations
GET
/
front-desk
/
enquiries
/
{id}
Enquiry
curl --request GET \
--url https://api.sortx.co.uk/front-desk/enquiries/{id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/front-desk/enquiries/{id}', 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/enquiries/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"enquiry": {
"id": "<string>",
"callId": "<string>",
"channel": "<string>",
"updatedAt": "<string>",
"whatsappThreadId": "<string>",
"contactId": "<string>",
"state": "<string>",
"intent": "<string>",
"outcome": "<string>",
"summary": "<string>",
"callerNumber": "<string>",
"startedAt": "<string>",
"endedAt": "<string>",
"durationSeconds": 123,
"providerConversationId": "<string>",
"teamId": "<string>",
"smsThreadId": "<string>"
},
"whatsapp": {
"threadId": "<string>",
"connectionId": "<string>",
"consent": "<string>",
"matchState": "<string>",
"windowExpiresAt": "<string>",
"enabled": true,
"displayName": "<string>",
"messages": [
{
"id": "<string>",
"clientId": "<string>",
"direction": "<string>",
"type": "<string>",
"text": "<string>",
"status": "<string>",
"error": "<string>",
"at": "<string>",
"mediaId": "<string>",
"filename": "<string>",
"mediaStored": true,
"mediaError": "<string>"
}
],
"templates": [
{
"id": "<string>",
"name": "<string>",
"language": "<string>",
"category": "<string>",
"status": "<string>",
"qualityRating": "<string>",
"rejectionReason": "<string>",
"body": "<string>",
"parameterCount": 123,
"supported": true,
"unsupportedReason": "<string>",
"lastSyncedAt": "<string>"
}
]
},
"transcript": [
{
"sequence": 123,
"role": "<string>",
"text": "<string>",
"at": "<string>"
}
],
"answers": [
{
"questionKey": "<string>",
"answer": "<string>"
}
],
"escalations": [
{
"id": "<string>",
"reason": "<string>",
"smsOutboxId": 123,
"taskId": "<string>",
"createdAt": "<string>"
}
],
"outcomes": [
{
"id": "<string>",
"enquiryId": "<string>",
"kind": "<string>",
"state": "<string>",
"payload": {},
"contactId": "<string>",
"propertyId": "<string>",
"summary": "<string>",
"acknowledgedByUserId": "<string>",
"acknowledgedAt": "<string>",
"note": "<string>",
"linkedKind": "<string>",
"linkedId": "<string>",
"createdAt": "<string>"
}
],
"outcomeChecks": [
{
"id": "<string>",
"status": "verified",
"reasons": [
{
"code": "<string>",
"detail": "<string>"
}
],
"assessmentIds": [
"<string>"
],
"model": "<string>",
"taskId": "<string>",
"createdAt": "<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.
Path Parameters
Response
Success
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes