Skip to navigation

Get payer groups

Beta
Returns all payer groups matching filter criteria.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

namestringOptional
payer_group_idUUIDOptional
payer_plan_group_idUUIDOptional
min_payer_plan_countintegerOptional

If provided, only returns payer groups that have at least this many active (non-deactivated) payer plans.

include_archivedbooleanOptional
If true, archived payer groups are included in the results. Defaults to false.
limitintegerOptional
Defaults to 100. Cannot exceed 1000.
sort_directionenumOptional
Sort direction. Defaults to ascending order if not provided.
Allowed values:
page_tokenstringOptional

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstringOptional
prev_page_tokenstringOptional

Errors

422
Unprocessable Entity Error