Basic search

Basic search is active when the advanced_search parameter is missing or set to 0:

/api/v2/calls.json?daterange=2024/11/01-2024/12/01&search_term=12345

Several parameters may be combined. All of them must match.

Parameter	Description
daterange	Filter by date range. The format is YYYY/MM/DD-YYYY/MM/DD or YYYY/MM/DD. The following query returns all recordings from 2024/11/01 00:00:00 to 2024/12/01 24:00:00: /api/v2/calls.json?daterange=2024/11/01-2024/12/01 The following query returns all recordings of 2024/11/01: /api/v2/calls.json?daterange=2024/11/01 The dates are interpreted in the time zone of the API user. If the user has no time zone configured, the time zone of the group, tenant, or system default is used.
user_id	Filter by user ID. /api/v2/calls.json?user_id=546340bf-7b47-11e4-85a4-e03f497dbdff
user_login	Filter by user login. /api/v2/calls.json?user_login=john.smith
group_id	Filter by group ID. /api/v2/calls.json?group_id=d1d83c40-eec7-11e4-8558-e03f497dbdff
tenant_id	Filter by tenant ID. /api/v2/calls.json?tenant_id=d1d83c40-eec7-11e4-8558-e03f497dbdff
search_term	Search a text in the phone numbers, phone names, original calling and dialed numbers, agent ID, and notes. Partial match, case insensitive. /api/v2/calls.json?search_term=1234
category_id	Filter by tag ID. /api/v2/calls.json?category_id=de8440f6-f291-11e4-9476-e03f497dbdff
client_id	Filter by client ID. /api/v2/calls.json?client_id=a58d0e04-a5de-4a86-9318-ee629e0814ae
broadworks_user_id	Filter by BroadWorks user ID. /api/v2/calls.json?broadworks_user_id=user@broadworks.com
broadworks_group_id	Filter by BroadWorks group ID. /api/v2/calls.json?broadworks_group_id=GroupA
protocol_tracking_id	Filter by PBX tracking ID. /api/v2/calls.json?protocol_tracking_id=12345
active_only	Return active calls only. /api/v2/calls.json?active_only=1
order_by	Sort order: call_desc (newest first, the default) or call_asc (oldest first). /api/v2/calls.json?order_by=call_asc
limit, start, max_total_calc	Paging parameters. See Collections.