Skip to main content
GET
List or search payers

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Scopes

eligibility:read

Query Parameters

A payer name or part of one, 1 to 100 characters after trimming, in any letter case. Matches names only, never an id.

Required string length: 1 - 100
state
string

One of the 50 states, DC, PR, GU, VI, AS or MP, or NATIONAL, in any letter case. Keeps payers that operate in that state, and national payers; NATIONAL keeps only national payers. An entry's states can carry a code this parameter refuses, for example FM.

programs
enum<string>[]

Comma-separated programs, in any letter case. Keeps payers that have any of them. An unknown program is a 400.

A program as the payer network reports it. The list is not published, and this enum grows when a new value appears.

Available options:
COMMERCIAL,
MEDICARE,
MEDICAID,
MEDICARE_ADVANTAGE,
TRICARE,
VETERANS_AFFAIRS,
WORKERS_COMPENSATION,
AUTOMOBILE_MEDICAL
limit
integer

Page size, from 1 to 200. Without it, every match comes in one response and paging is off.

Required range: 1 <= x <= 200
cursor
string

The next_cursor of the previous page, passed back unchanged with the same search, state, programs and limit. Only valid with limit, and only until the directory next refreshes: an expired cursor is a 400 that tells you to restart without one.

Response

The matching payers. No match is a 200 with an empty payers.

data
object
required
request_id
string
required
Example:

"c1a7f3e2-5b9d-4a68-9f21-7d3c4b6e8a05"