API & Services Connection™
Guides
Request Sandbox AccessMarketplaceCommunityQuick Reference

PayerList FAQs

Suggest Edits

What is PayerList v1 API?

Please see PayerList getting started.

Which payer lists does the PayerList API support?

See Payer List UI.

What does a typical PayerList API request look like?

The GET /payers endpoint retrieves the payer lists across transactions.

Unified access and filtering of payer list — at a hierarchical level, the system parameter is the highest level and is the only required parameter. You can filter and sort by using the system parameter to get a complete list of payers and transactions with their related information for a specific system/clearinghouse. You can further filter and sort based ontransactionType, payerId, enrollment, and other parameters to search across transactions. For a complete list of filters and sorting, see PayerList filter and sort.

/payerlist/v1/payers?system=[SYSTEM]&transactionType=[TRANSACTIONTYPE_1] &transactionType=[TRANSACTIONTYPE_2] &transactionType=[TRANSACTIONTYPE_N]

For more examples, see PayerList examples.

The PayerList API also supports operations, such as checking the health of the API, exporting the payer list to a CSV file, and retrieving the fields for querying the payer data.

What does a typical PayerList v1 API response look like?

See PayerList examples.

Which data fields/JSON attributes can I use in the PayerList API for searching?

You can search using any of the available PayerList filter and sort. The system parameter is the highest level and is the only required parameter. You can filter and sort by using the system parameter to get a complete list of payers and transactions with their related information for a specific system/clearinghouse. You can further filter and sort based ontransactionType, payerId, enrollment, and other parameters to search across transactions.

  • Control how many records and which to start from, using the size and start parameters
/payers?businessName=aetna&size=25&start=50

This query returns 25 records having businesName with aetna starting with record number 50.

The API also returns:

  • start: tells where the offset starts
  • size: number of payers displayed in the response, which will default to '50' and can be changed through query parameter (size)

In which format can I download the PayerList?

  1. Yes, use the v1/payers/export endpoint to export the PayerList as a CSV file.
  2. Enter the payer name in the text box and click Enter.
  3. Click Export.
    The CSV file for the selected payer name downloads.

Related Topics

Updated 18 days ago