Get payer plan groups

Returns all payer plan groups matching filter criteria.

Headers

AuthorizationstringRequired

OAuth authentication of the form <token>.

Query parameters

plan_group_namestringOptional
payer_uuidUUIDOptional
payer_idstringOptional
plan_typeenumOptional
is_activebooleanOptional
payer_plan_group_idUUIDOptional
limitintegerOptional

Defaults to 100. Cannot exc

sort_by_similaritystringOptional

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.

sortenumOptional

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

Allowed values:
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