API documentation

GET /buyer_groups/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyer_groups/:id

Get an individual Buyer Group by id

Gets a Buyer Group's details by id, including its concurrency, cap usage, and dial_buyers_type configuration.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "buyer_group": {
    "id": 10001,
    "type": "BuyerGroup",
    "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": "/buyer_groups/10001",
    "routes_edit_path": "/buyer_groups/10001/edit",
    "external_record_id": "example-record-1",
    "concurrency_cap_limit": null,
    "concurrency_cap_used": 0,
    "buyer_ids": [
      10002,
      10003,
      10004
    ],
    "buyers_count": 3,
    "company_id": 10005,
    "name": "Insurance Overflow",
    "maxed_out": false,
    "weight": 1,
    "tier": 1,
    "time_zone": "EST",
    "paused": false,
    "paused_at": null,
    "paused_by_user_id": null,
    "unpaused_at": null,
    "dial_buyers_type": "sequentially",
    "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": "0.0",
    "earned_revenue_hourly_used": "0.0",
    "earned_revenue_monthly_used": "0.0",
    "earned_revenue_total_used": "0.0",
    "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
  },
  "metadata": {
    "root": "buyer_group"
  }
}