API documentation

GET /buyers/:user_buyer_id/by_user_buyer_id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyers/:user_buyer_id/by_user_buyer_id

Get a buyer by your buyer ID

Retrieves a single buyer using the user_buyer_id you assigned to it, instead of Trackdrive's internal ID. Use this when your own system references buyers by its own identifier so you do not need to store Trackdrive's ID separately.

Params

Param name Description

serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

Must be a value contained in the pick list:

Acceptable Value Description
buyer Default response format.
buyer_grid Modern response format that returns various foreign keys for use with other API endpoints.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/buyers/10001/by_user_buyer_id' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "buyer": {
    "id": 10002,
    "type": "Buyer",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": "2026-01-15T15:30:00.000Z",
    "routes_show_path": "/buyers/10002",
    "routes_edit_path": "/buyers/10002/edit",
    "external_record_id": "example-record-1",
    "name": "Overflow Insurance Buyer",
    "context_menu_name": "10001 - Overflow Insurance Buyer - +18885001010",
    "email": null,
    "number": "+18885001010",
    "paused": false,
    "time_zone": "Eastern Time (US & Canada)",
    "user_buyer_id": "10003",
    "bid_price": 32.0,
    "route_by_type": "tier",
    "buyer_type": "buyer",
    "buyer_group_ids": [
      10004
    ],
    "buyer_group_names": [
      "Insurance Overflow"
    ],
    "token_values": [],
    "token_values_hash": {},
    "attribution_token_values": [],
    "attribution_token_values_hash": {},
    "last_call_at": null,
    "weight": 1,
    "tier": 5.0,
    "timeout_seconds": 15,
    "dtmf_tones": null,
    "concurrency_cap_limit": null,
    "concurrency_cap_used": 0,
    "maxed_out_by": null,
    "current_conversion_revenue_max": null,
    "current_conversion_revenue_min": null,
    "current_conversion_revenue_increment": "0.01",
    "current_conversion_revenue": 32.0,
    "current_conversion_duration": 30,
    "current_conversion_duplicate_timeframe": 86400,
    "current_conversion_name": "Qualified connected call",
    "current_conversion_token_value_ids": null,
    "current_conversion_attribution_token_value_ids": null,
    "ping_timeout_seconds": null,
    "buyer_suppression_ids": [],
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_id": null,
    "record_token_additional_data_count": 0,
    "record_token_additional_data": [],
    "attempt_daily_used": 0,
    "attempt_hourly_used": 0,
    "attempt_monthly_used": 0,
    "attempt_total_used": 0,
    "buyer_conversion_daily_used": 0,
    "buyer_conversion_hourly_used": 0,
    "buyer_conversion_monthly_used": 0,
    "buyer_conversion_total_used": 0,
    "connection_daily_used": 0,
    "connection_hourly_used": 0,
    "connection_monthly_used": 0,
    "connection_total_used": 0,
    "earned_revenue_daily_used": null,
    "earned_revenue_hourly_used": null,
    "earned_revenue_monthly_used": null,
    "earned_revenue_total_used": null,
    "revenue_daily_used": 0.0,
    "revenue_hourly_used": 0.0,
    "revenue_monthly_used": 0.0,
    "revenue_total_used": 0.0,
    "attempt_daily_limit": null,
    "attempt_hourly_limit": null,
    "attempt_monthly_limit": null,
    "attempt_total_limit": null,
    "buyer_conversion_daily_limit": null,
    "buyer_conversion_hourly_limit": null,
    "buyer_conversion_monthly_limit": null,
    "buyer_conversion_total_limit": null,
    "connection_daily_limit": null,
    "connection_hourly_limit": null,
    "connection_monthly_limit": null,
    "connection_total_limit": null,
    "earned_revenue_daily_limit": null,
    "earned_revenue_hourly_limit": null,
    "earned_revenue_monthly_limit": null,
    "earned_revenue_total_limit": null,
    "revenue_daily_limit": null,
    "revenue_hourly_limit": null,
    "revenue_monthly_limit": null,
    "revenue_total_limit": null,
    "business_hours_schedule": [
      {
        "attempt_hourly_limit": null,
        "connection_hourly_limit": null,
        "buyer_conversion_hourly_limit": null,
        "revenue_hourly_limit": null,
        "concurrency_limit": null,
        "buyer_spacing_type": null,
        "buyer_spacing_limit": null,
        "buyer_spacing_seconds": null,
        "buyer_spacing_minutes": null,
        "buyer_spacing_hours": null,
        "schedule": [
          {
            "day": 0,
            "times": [
              "00:00..23:59"
            ]
          },
          {
            "day": 1,
            "times": [
              "00:00..23:59"
            ]
          },
          {
            "day": 2,
            "times": [
              "00:00..23:59"
            ]
          }
        ]
      }
    ],
    "buyer_conversions_schedule": [
      {
        "buyer_conversions_attributes": [
          {
            "name": "Qualified connected call",
            "duration": 30,
            "revenue": 32.0,
            "duplicate_timeframe": 86400,
            "revenue_min": null,
            "revenue_max": null,
            "revenue_increment": "0.01"
          }
        ],
        "schedule": [
          {
            "day": 0,
            "times": [
              "00:00..23:59"
            ]
          },
          {
            "day": 1,
            "times": [
              "00:00..23:59"
            ]
          },
          {
            "day": 2,
            "times": [
              "00:00..23:59"
            ]
          }
        ]
      }
    ]
  },
  "metadata": {
    "root": "buyer"
  }
}