Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

List lead orders

GET /api/v2/lead-orders - Returns lead orders for the agency.

GET/api/v2/lead-orders

Returns lead orders for the agency.

Required scope: lead-orders (or *).

curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/lead-orders"
{
  "success": true,
  "orders": [{
    "order_uuid": "c0a80101-0000-4000-8000-000000000006",
    "status": "active",
    "paused": false,
    "quantity": 100,
    "daily_max": 25
  }]
}

See Errors for the standard error envelope and rate limits.