Skip to main content

Search detail records

GET 
/detail_records

Search for any detail record across the Telnyx Platform

Request

Query Parameters

    filter[record_type] stringrequired

    Possible values: [amd, conference, conference-participant, media_storage, messaging, verify, whatsapp, whatsapp-conversation, wireless]

    Filter by the given record type.

    Examples:
    filter[date_range] string

    Possible values: [yesterday, today, tomorrow, last_week, this_week, next_week, last_month, this_month, next_month]

    Filter by the given user-friendly date range. You can specify one of the following enum values, or a dynamic one using this format: last_N_days.

    Examples:
    filter object

    Filter records on a given record attribute and value.
    Example: filter[status]=delivered

    Examples:
    page[number] int32

    Possible values: >= 1

    Default value: 1

    Page number

    page[size] int32

    Possible values: >= 1 and <= 50

    Default value: 20

    Page size

    sort string[]

    Specifies the sort order for results.
    Example: sort=-created_at

    Examples:

Responses

200: Successful

Request samples


curl -L 'https://api.telnyx.com/v2/detail_records' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


{
"data": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}