---
title: "Search detail records"
method: GET
path: "/detail_records"
tags: ["Detail Records"]
---

# Search detail records

`GET /detail_records`

Search for any detail record across the Telnyx Platform

## Query parameters

- `filter` object
  - `record_type` 'ai-voice-assistant' | 'amd' | 'call-control' | 'conference' | 'conference-participant' | 'embedding' | 'fax' | 'inference' | 'inference-speech-to-text' | 'media_storage' | 'media-streaming' | 'messaging' | 'noise-suppression' | 'recording' | 'sip-trunking' | 'siprec-client' | 'stt' | 'tts' | 'verify' | 'webrtc' | 'wireless', required — Filter by the given record type.
  - `date_range` '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.
- `sort` string[]
- `page[number]` integer
- `page[size]` integer

## Response `200`

Successful

- DetailRecordsSearchResponse
  - `data` DetailRecord[]
    - union — An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
      - object
        - `uuid` string — Unique identifier of the message
        - `user_id` string — Identifier of the Telnyx account who owns the message
        - `completed_at` string, date-time — Message completion time
        - `created_at` string, date-time — Message creation time
        - `updated_at` string, date-time — Message updated time
        - `sent_at` string, date-time — Time when the message was sent
        - `carrier` string — Country-specific carrier used to send or receive the message
        - `carrier_fee` string — Fee charged by certain carriers in order to deliver certain message types. Telnyx passes this fee on to the customer according to our pricing table
        - `cld` string — The recipient of the message (to parameter in the Messaging API)
        - `cli` string — The sender of the message (from parameter in the Messaging API). For Alphanumeric ID messages, this is the sender ID value
        - `country_code` string — Two-letter representation of the country of the cld property using the ISO 3166-1 alpha-2 format
        - `delivery_status` string — Final webhook delivery status
        - `delivery_status_failover_url` string — Failover customer-provided URL which Telnyx posts delivery status webhooks to
        - `delivery_status_webhook_url` string — Primary customer-provided URL which Telnyx posts delivery status webhooks to
        - `direction` 'inbound' | 'outbound' — Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise
        - `fteu` boolean — Indicates whether this is a Free-To-End-User (FTEU) short code message
        - `mcc` string — Mobile country code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID
        - `mnc` string — Mobile network code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID
        - `message_type` 'SMS' | 'MMS' | 'RCS' — Describes the Messaging service used to send the message. Available services are: Short Message Service (SMS), Multimedia Messaging Service (MMS), and Rich Communication Services (RCS)
        - `on_net` boolean — Indicates whether both sender and recipient numbers are Telnyx-managed
        - `profile_id` string — Unique identifier of the Messaging Profile used to send or receive the message
        - `profile_name` string — Name of the Messaging Profile used to send or receive the message
        - `source_country_code` string — Two-letter representation of the country of the cli property using the ISO 3166-1 alpha-2 format
        - `status` 'gw_timeout' | 'delivered' | 'dlr_unconfirmed' | 'dlr_timeout' | 'received' | 'gw_reject' | 'failed' — Final status of the message after the delivery attempt
        - `tags` string — Comma-separated tags assigned to the Telnyx number associated with the message
        - `rate` string — Currency amount per billing unit used to calculate the Telnyx billing cost
        - `currency` string — Telnyx account currency used to describe monetary values, including billing cost
        - `cost` string — Amount, in the user currency, for the Telnyx billing cost
        - `errors` string[] — Telnyx API error codes returned by the Telnyx gateway
        - `parts` integer — Number of message parts. The message is broken down in multiple parts when its length surpasses the limit of 160 characters
        - `record_type` string, required — Identifies the record schema
      - object
        - `id` string — Conference id
        - `name` string — Conference name
        - `user_id` string — User id
        - `started_at` string, date-time — Conference start time
        - `ended_at` string, date-time — Conference end time
        - `expires_at` string, date-time — Conference expiry time
        - `region` string — Region where the conference is hosted
        - `call_leg_id` string — Telnyx UUID that identifies the conference call leg
        - `call_session_id` string — Telnyx UUID that identifies with conference call session
        - `connection_id` string — Connection id
        - `call_sec` integer — Duration of the conference call in seconds
        - `participant_count` integer — Number of participants that joined the conference call
        - `participant_call_sec` integer — Sum of the conference call duration for all participants in seconds
        - `is_telnyx_billable` boolean — Indicates whether Telnyx billing charges might be applicable
        - `record_type` string, required
      - object
        - `id` string — Participant id
        - `user_id` string — User id
        - `conference_id` string — Conference id
        - `joined_at` string, date-time — Participant join time
        - `left_at` string, date-time — Participant leave time
        - `destination_number` string — Number called by the participant to join the conference
        - `originating_number` string — Participant origin number used in the conference call
        - `call_leg_id` string — Telnyx UUID that identifies the conference call leg
        - `call_session_id` string — Telnyx UUID that identifies with conference call session
        - `call_sec` integer — Duration of the conference call in seconds
        - `billed_sec` integer — Duration of the conference call for billing purposes
        - `is_telnyx_billable` boolean — Indicates whether Telnyx billing charges might be applicable
        - `rate` string — Currency amount per billing unit used to calculate the Telnyx billing cost
        - `rate_measured_in` string — Billing unit used to calculate the Telnyx billing cost
        - `cost` string — Currency amount for Telnyx billing cost
        - `currency` string — Telnyx account currency used to describe monetary values, including billing cost
        - `record_type` string, required
      - object
        - `id` string — Feature invocation id
        - `invoked_at` string, date-time — Feature invocation time
        - `feature` 'PREMIUM' — Feature name
        - `tags` string — User-provided tags
        - `billing_group_id` string — Billing Group id
        - `billing_group_name` string — Name of the Billing Group specified in billing_group_id
        - `connection_id` string — Connection id
        - `connection_name` string — Connection name
        - `call_leg_id` string — Telnyx UUID that identifies the related call leg
        - `call_session_id` string — Telnyx UUID that identifies the related call session
        - `is_telnyx_billable` boolean — Indicates whether Telnyx billing charges might be applicable
        - `rate` string — Currency amount per billing unit used to calculate the Telnyx billing cost
        - `rate_measured_in` string — Billing unit used to calculate the Telnyx billing cost
        - `cost` string — Currency amount for Telnyx billing cost
        - `currency` string — Telnyx account currency used to describe monetary values, including billing cost
        - `record_type` string, required
      - object
        - `id` string, uuid — Unique ID of the verification
        - `verify_profile_id` string, uuid
        - `delivery_status` string
        - `verification_status` string
        - `destination_phone_number` string — E.164 formatted phone number
        - `verify_channel_type` 'sms' | 'psd2' | 'call' | 'flashcall' — Depending on the type of verification, the `verify_channel_id` points to one of the following channel ids; --- verify_channel_type | verify_channel_id ------------------- | ----------------- sms, psd2 | messaging_id call, flashcall | call_control_id ---
        - `verify_channel_id` string, uuid
        - `created_at` string, date-time
        - `updated_at` string, date-time
        - `rate` string — Currency amount per billing unit used to calculate the Telnyx billing costs
        - `rate_measured_in` string — Billing unit used to calculate the Telnyx billing costs
        - `verify_usage_fee` string — Currency amount for Verify Usage Fee
        - `currency` string — Telnyx account currency used to describe monetary values, including billing costs
        - `record_type` string, required
      - object
        - `id` string, uuid — Unique identifier for this SIM Card Usage
        - `created_at` string, date-time — Event creation time
        - `closed_at` string, date-time — Event close time
        - `ip_address` string — Ip address that generated the event
        - `downlink_data` number — Number of megabytes downloaded
        - `imsi` string — International Mobile Subscriber Identity
        - `mcc` string — Mobile country code
        - `mnc` string — Mobile network code
        - `currency` string — Telnyx account currency used to describe monetary values, including billing cost
        - `data_unit` string — Unit of wireless link consumption
        - `data_rate` string — Currency amount per billing unit used to calculate the Telnyx billing cost
        - `sim_group_name` string — Sim group name for sim card
        - `sim_card_id` string — Unique identifier for SIM card
        - `sim_group_id` string — Unique identifier for SIM group
        - `sim_card_tags` string — User-provided tags
        - `phone_number` string — Telephone number associated to SIM card
        - `uplink_data` number — Number of megabytes uploaded
        - `data_cost` number — Data cost
        - `record_type` string, required
      - object
        - `id` string — Unique identifier for the Media Storage Event
        - `created_at` string, date-time — Event creation time
        - `asset_id` string — Asset id
        - `user_id` string — User id
        - `org_id` string — Organization owner id
        - `action_type` string — Type of action performed against the Media Storage API
        - `link_channel_type` string — Link channel type
        - `link_channel_id` string — Link channel id
        - `status` string — Request status
        - `webhook_id` string — Webhook id
        - `rate` string — Currency amount per billing unit used to calculate the Telnyx billing cost
        - `rate_measured_in` string — Billing unit used to calculate the Telnyx billing cost
        - `cost` string — Currency amount for Telnyx billing cost
        - `currency` string — Telnyx account currency used to describe monetary values, including billing cost
        - `record_type` string, required
  - `meta` DetailRecordsPaginationMeta
    - `total_pages` integer, required
    - `total_results` integer
    - `page_number` integer, required
    - `page_size` integer

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/versions/e32d46c5945b/schema)