Skip to main content
GET
Search CDRs with filter summary
Search behaves exactly like List CDRs - same filters, same data, pagination, and summary - but the response adds a filters object echoing the active filter values. Use it to power search UIs that need to display the current filter state, or to confirm which filters the server actually applied.

Search or list?

Filters

Identical to the list endpoint: from_number, to_number, start_date + end_date (paired, YYYY-MM-DD), call_direction (inbound/outbound), min_duration (seconds), sip_call_id, bridge_uuid, hangup_cause, hangup_disposition, context, campaign_id, search (free-text), page (default 1), per_page (default 20, max 100). See List CDRs for the full table. All filters are optional and combine with AND.

The filters echo

The response includes:
Unset filters echo back as empty strings (""), not as missing keys or null. The filters object always carries all four keys.

Response

A successful search returns 200 OK with the same envelope as List CDRs, plus filters.

Pagination

Loop while has_next is true, incrementing page.

Summary

summary is computed over the filtered set, not your whole account.

CDR fields

Each item in data is a CDR object with these 43 fields, the same as List CDRs returns.

Example

This request searches outbound calls from one caller number, 50 per page. The filters object in the response echoes call_direction and from_number.
cURL
See the CDR overview for the field glossary and Hangup Causes for hangup decoding.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Query Parameters

from_number
string

Filter by the originating phone number (caller).

Example:

"9876543210"

to_number
string

Filter by the destination phone number (callee).

Example:

"1234567890"

start_date
string<date>

Beginning of the search period (YYYY-MM-DD). Required when using end_date.

Example:

"2026-03-01"

end_date
string<date>

End of the search period (YYYY-MM-DD). Required when using start_date.

Example:

"2026-03-17"

call_direction
enum<string>

Filter by direction.

Available options:
inbound,
outbound
min_duration
integer

Minimum call duration in seconds. Excludes calls shorter than this value.

Example:

10

sip_call_id
string

Filter by the SIP Call-ID of the call (matches the cdr's sip_call_id field).

Example:

"dD1qwu5VZ5iK3ed5u3uspjY5RKL"

bridge_uuid
string

Filter by the UUID of the bridged leg (matches the cdr's bridge_uuid field).

Example:

"4b7ae653-f40d-42f1-b582-6b05dfcd0c0a"

hangup_cause
string

Filter by telephony hangup cause, e.g. NORMAL_CLEARING.

Example:

"NORMAL_CLEARING"

hangup_disposition
string

Filter by how the leg was released, e.g. send_refuse.

Example:

"send_refuse"

context
string

Filter by the call context, e.g. sip-trunking.

Example:

"sip-trunking"

campaign_id
string

Filter by the campaign identifier associated with the call.

Free-text search across CDR fields (numbers, IDs, etc.).

page
integer
default:1

Page number for paginated results.

per_page
integer
default:20

Number of records per page. Max: 100.

Required range: x <= 100

Response

200 - application/json

CDR list with active filter summary

account_id
string
required
count
integer
required
data
object[]
required
filters
object
required
pagination
object
required

Page-based pagination returned in the pagination object of the CDR list and search endpoints and the partner customer CDR endpoint. Loop while has_next is true, incrementing page.

success
boolean
required
summary
object
required