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 fields

GET /api/v2/fields - Paginated custom fields with optional search and status filter.

GET/api/v2/fields

Paginated custom fields with optional search and status filter.

Required scope: fields (or *).

Query parameters

NameRequiredDescription
pageNoPage number (default 1)
limitNoPage size
searchNoSearch label / key
statusNoactive (default), archived, or all
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/fields?page=1&limit=50&search=plan&status=active"
{
  "success": true,
  "fields": [{
    "field_id": "plan_type",
    "label": "Plan type",
    "field_type": "dropdown_single",
    "status": "active"
  }]
}

See Errors for the standard error envelope and rate limits.