Get payer plans

Returns all payer plans matching filter criteria.

get/api/payer-plan-groups/v1

Query parameters

plan_group_namestring

payer_uuidV3PayerUuid — unresolved $ref

payer_idV3PayerId — unresolved $ref

plan_type'09' | '11' | '12' | '13' | '14' | '15' | '16' | '17' | 'AM' | 'BL' | 'CH' | 'CI' | 'DS' | 'FI' | 'HM' | 'LM' | 'MA' | 'MB' | 'MC' | 'OF' | 'TV' | 'VA' | 'WC' | 'ZZ'

is_activeboolean

payer_plan_group_idstring uuid

limitinteger

Defaults to 100. Cannot exc

sort_by_similaritystring

If this property is passed, the results will be ordered by those that contain a payer_id, payer_name, plan_group_name, or payer_address most similar to the value passed. This will take precedence over the sort and sort_direction properties. This will always sort in order of most similar to least similar.

sortV1PayerPlanGroupSortField — unresolved $ref

Defaults to plan_group_name. If sort_by_similarity is passed, that sort will takes precedence over this property.

sort_direction'asc' | 'desc'

Sort direction. Defaults to ascending order if not provided.

page_tokenstring

organization_idstring uuid

Filter to a specific organization's payer plans. If not provided, defaults to the requesting user's organization.

Headers

Authorizationstring required

OAuth authentication

Response

Response with status 200

V1PayerPlanGroupPage required— unresolved $ref