JOjoincandidhealth
v1

Get payer plan

Changed on

Return a payer plan with a given ID.

get/api/payer-plan-groups/v1/{payer_plan_group_id}

Request

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

Path parameters

payer_plan_group_idstring uuid required

Response

Response with status 200

plan_group_namestring required
payer_uuidstring uuid required
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' required
payer_plan_group_idstring uuid required
is_activeboolean required
organization_idstring uuid required

Changes

  • 24b2d80d577aRevision changes
    • 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 required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id get removed and replaced with v1_get_24