A call to or from a prospective care seeker.
A unique Id for the call.
An AI generated summary of the call.
Date/time flag indicating when (if) the call's details were anonymized.
Flag indicating that the call was answered by a machine.
The date/time the call was answered.
Flag indicating if the call was successful.
The Id of the care enquiry this call relates to.
The date/time the call was created.
The date/time the call was initiated or received.
The telephone number that the call was to.
The direction of the call; inbound, outbound.
Flag indicating if the call has ended.
The date/time the call was ended.
The service used to handle the call.
The Id of the location this call relates to.
The date/time the call was modified.
The telephone number that the call originates from.
The date/time the call started ringing the destination.
The reason for the call.
The Id of the service user contact this call relates to.
The call status; busy, canceled, completed, failed, in_progress, no_answer, queued, ringing.
A summary of the call and its outcome.
The Id of the user who made this call.
{
"_id": "6a7a1e9060776d91dc87ac32",
"ai_summary": null,
"anonymized": null,
"answered_by_machine": false,
"answered_date_time": "2026-08-07 14:30:25",
"call_successful": true,
"care_enquiry": "6a7a1e8d60776d91dc87a94e",
"created": "2026-08-10 18:55:12",
"date_time": "2026-08-07 14:30:00",
"destination": "+441905381713",
"direction": "outbound",
"ended": true,
"ended_date_time": "2026-08-07 14:42:15",
"external_service": "twilio",
"location": "6a7a1e8860776d91dc879ba0",
"modified": "2026-08-10 18:55:12",
"origin": "+441865680331",
"reason_for_call": "6a7a1e8560776d91dc879a9c",
"ringing_date_time": "2026-08-07 14:30:10",
"service_user_contact": null,
"status": "completed",
"summary": "Spoke to Gordon and answers some questions around price. Gordon was at work and\nasked if I could call him tomorrow to arrange a home visit.\n",
"user": "6a7a1e8860776d91dc879baa"
}
Return a list of calls.
['_id']
A list of attributes to include for fetched objects.
unset
A filter that allows calls to be filtered by whether the call is anonymized.
A filter that accepts a list of call statuses and filters calls by the status of the call.
A filter that accepts a list of care enquiry Ids and filters calls to those where the call relates to one of the care enquiries.
A filter that allows calls to be filtered by the direction calls were sent in.
A filter that accepts a date and filters calls to those sent or received on or before the given date.
A filter that accepts a list of Ids and filters the items returned to those with an Id in the list.
A filter that accepts a list of location Ids and filters calls by the location they relate to.
A filter that accepts a date/time and filters the items returned to those modified after the date/time.
A filter that accepts a date/time and filters the items returned to those modified before the date/time.
A case insensitive keyword filter applied to the following fields; destination, origin.
A filter that accepts a list of service user contact Ids and filters calls to those where the service user contact is one of the service user contacts.
A filter that accepts a date and filters calls to those sent or received on or after the given date.
A filter that accepts a list of user Ids and filters calls to those initiated by one of the users.
1
The page number to fetch.
10
The number of items to return per page.
_id
A list of fields the returned items can be sorted by. Fields prefixed with minus (-) sign are sorted in descending order.
Returns a page of calls.
var calls = apiClient.Request(
HttpMethod.Get,
"calls",
new MultiValueDict()
.Add("attributes", "call_status", "destination", "date_time")
.Add("filters-direction", "outbound")
.Add("sort_by", "date_time")
);
const calls = await apiClient.request(
"GET",
"calls",
{
"params": {
"attributes": ['call_status', 'destination', 'date_time'],
"filters-direction": ["outbound"],
"sort_by": "date_time"
}
}
)
<?php
$calls = $api_client->request(
'GET',
'calls',
[
'attributes'=>['call_status', 'destination', 'date_time'],
'filters-direction'=>['outbound'],
'sort_by'=>'date_time'
]
);
calls = api_client(
'GET',
'calls',
params={
'attributes': ['call_status', 'destination', 'date_time'],
'filters-direction': ['outbound'],
'sort_by': 'date_time'
}
)
calls = api_client.request(
'GET',
'calls',
params: {
'attributes' => ['call_status', 'destination', 'date_time'],
'filters-direction' => ['outbound'],
'sort_by' => 'date_time'
}
)
{
"item_count": 5,
"items": [
{
"_id": "6a7a1e9060776d91dc87ac34",
"date_time": "2026-07-23 17:00:00",
"destination": "+447205755726"
},
{
"_id": "6a7a1e9060776d91dc87ac36",
"date_time": "2026-07-26 12:00:00",
"destination": "+447205755726"
},
{
"_id": "6a7a1e9060776d91dc87ac32",
"date_time": "2026-08-07 14:30:00",
"destination": "+441905381713"
},
{
"_id": "6a7a1e9060776d91dc87ac30",
"date_time": "2026-08-08 10:30:00",
"destination": "+441905381713"
},
{
"_id": "6a7a1e9060776d91dc87ac2e",
"date_time": "2026-08-09 16:50:00",
"destination": "+07865443145"
}
],
"page": 1,
"page_count": 1,
"per_page": 10
}
var call = apiClient.Request(HttpMethod.Get, $"calls/{callId}");
const call = await apiClient.request("GET", `calls/${callsId}`)
<?php
$call = $api_client->request('GET', 'calls/' . $call_id);
call = api_client('GET', f'calls/{call_id}')
call = api_client.request('GET', "calls/#{call_id}")
{
"_id": "6a7a1e9060776d91dc87ac32",
"ai_summary": null,
"anonymized": null,
"answered_by_machine": false,
"answered_date_time": "2026-08-07 14:30:25",
"call_successful": true,
"care_enquiry": "6a7a1e8d60776d91dc87a94e",
"created": "2026-08-10 18:55:12",
"date_time": "2026-08-07 14:30:00",
"destination": "+441905381713",
"direction": "outbound",
"ended": true,
"ended_date_time": "2026-08-07 14:42:15",
"external_service": "twilio",
"location": "6a7a1e8860776d91dc879ba0",
"modified": "2026-08-10 18:55:12",
"origin": "+441865680331",
"reason_for_call": "6a7a1e8560776d91dc879a9c",
"ringing_date_time": "2026-08-07 14:30:10",
"service_user_contact": null,
"status": "completed",
"summary": "Spoke to Gordon and answers some questions around price. Gordon was at work and\nasked if I could call him tomorrow to arrange a home visit.\n",
"user": "6a7a1e8860776d91dc879baa"
}