JOjoincandidhealth
v1

Get payer plans

Changed on

Returns all payer plans matching filter criteria.

get/api/payer-plan-groups/v1

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/payer-plan-groups/v1
  • Auth
    HTTP bearer

Query parameters

plan_group_namestring
payer_uuidstring uuid
payer_group_idstring uuid

Filter to payer plans under the provided payer group.

payer_idstring
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.

sort'plan_group_name' | 'plan_type' | 'created_at'

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.

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 68a90ec8025fRevision changes
    • info

      added the new optional query request parameter payer_group_id

  • 24b2d80d577aRevision changes
    • breaking

      the query request parameter sort was restricted to a list of enum values

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new enum value created_at to the query request parameter sort

    • info

      added the new enum value plan_group_name to the query request parameter sort

    • info

      added the new enum value plan_type to the query request parameter sort

    • info

      for the query request parameter payer_id, the type was generalized from no type to string

    • info

      for the query request parameter payer_uuid, the type was generalized from no type to string, and format from no format to uuid

    • info

      for the query request parameter sort, the type was generalized from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status