Directories API

Search claims administrators

Browse the payer directory or search administrators and payer choices before a bill exists.

GEThttps://app.mindbill.org/partner/v2/claims-administrators

Populate the claims-administrator selector in your own bill-entry form. listClaimsAdministrators() and searchClaimsAdministrators() call this endpoint; the SDK normalizes the raw directory response for the React components.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: payers:read · Browser: payers:read

IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Query parameters

FieldTypeDescription

q

string

Administrator name search. Omit or leave blank to browse the directory.

claimNumber

string

Optional claim number used for matching hints.

sourceClaimsAdministratorName

string

Administrator name from the source record, used to rank matches.

employerName

string

Optional employer context for recommendations.

limit

integer

Page size; default 50, clamped to 1–100.

offset

integer

Zero-based offset; default 0.

Examples

curl 'https://app.mindbill.org/partner/v2/claims-administrators?q=Example&limit=20' \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

curl 'https://app.mindbill.org/partner/v2/claims-administrators?q=Example&limit=20' \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example'

Response

200 OK

{
  "results": [
    {
      "id": "admin_example",
      "name": "Example Claims Administrator",
      "hasElectronic": false,
      "states": [
        "CA"
      ],
      "confidence": "directory",
      "recommended": false,
      "signals": [],
      "payers": [
        {
          "key": "payer_example",
          "label": "Example Insurance",
          "default": true,
          "active": true
        }
      ],
      "payerSelectionRequired": false,
      "claimNumberPatterns": []
    }
  ],
  "recommendedId": null,
  "suggestions": [],
  "total": 1
}

FieldTypeDescription

results[]

object[]

Ranked directory entries for this page. The response is top-level, without a data wrapper.

results[].id

string

Opaque directory identifier. Send as claim.claimsAdministrator.id.

results[].name

string

Canonical display name. Send as claim.claimsAdministrator.name.

results[].hasElectronic

boolean

Whether the directory entry has electronic delivery support.

results[].states

string[]

States associated with the directory entry.

results[].confidence

"high" | "medium" | "directory"

Match confidence.

results[].recommended

boolean

Whether this entry is recommended for the supplied context.

results[].signals[]

object[]

Matching hints with kind (name or claim_number), state (match or warning), and label.

results[].payers[]

object[]

Payer choices with key, label, default, active, and optional affiliatedEntities and claimNumberPatterns.

results[].payers[].key

string

Opaque payer-choice key. The SDK exposes this as a payer id; send it as claim.claimsAdministrator.payerId.

results[].payerSelectionRequired

boolean

Whether a payer choice is needed within this administrator.

results[].aliases / affiliatedEntities

string[]

Optional alternate names and affiliated entities.

results[].claimNumberPatterns[]

object[]

Patterns with pattern, optional length/example, and matches (boolean or null when no claim number was supplied or the pattern cannot be evaluated).

recommendedId

string | null

Exact-match recommendation, or null. Recommendations do not replace user review.

suggestions[]

object[]

Suggested directory entries with deterministic, reason, and optional selectedPayerId.

total

integer

Total matching entries before pagination.

nextOffset

integer

Offset for the next page; omitted on the last page.