{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_auth.subpackage_auth/default subpackage_payer-plan-groups.subpackage_payer-plan-groups/v1 API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_payer-plan-groups.subpackage_payer-plan-groups/v1", "type": "folder" }, "items": [ { "info": { "name": "Get payer plan groups", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/payer-plan-groups/v1", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "plan_group_name", "value": "", "type": "query" }, { "name": "payer_uuid", "value": "", "type": "query" }, { "name": "payer_id", "value": "", "type": "query" }, { "name": "plan_type", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "payer_plan_group_id", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Defaults to 100. Cannot exc" }, { "name": "sort_by_similarity", "value": "", "type": "query", "description": "If this property is passed, the results will be ordered by those that contain a payer_id, payer_name, plan_group_name, or\npayer_address most similar to the value passed. This will take precedence over the sort and sort_direction properties. This\nwill always sort in order of most similar to least similar." }, { "name": "sort", "value": "", "type": "query", "description": "Defaults to plan_group_name. If sort_by_similarity is passed, that sort will takes precedence over this property." }, { "name": "sort_direction", "value": "", "type": "query", "description": "Sort direction. Defaults to ascending order if not provided." }, { "name": "page_token", "value": "", "type": "query" }, { "name": "organization_id", "value": "", "type": "query", "description": "Filter to a specific organization's payer plan groups. If not provided, defaults to the requesting user's organization." } ] }, "docs": "Returns all payer plan groups matching filter criteria." }, { "info": { "name": "Create a payer plan group", "type": "http" }, "http": { "method": "POST", "url": "https://pre-api.joincandidhealth.com/api/payer-plan-groups/v1", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a payer plan group" }, { "info": { "name": "Get payer plan group", "type": "http" }, "http": { "method": "GET", "url": "https://pre-api.joincandidhealth.com/api/payer-plan-groups/v1/:payer_plan_group_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "payer_plan_group_id", "value": "", "type": "path" } ] }, "docs": "Return a plan group with a given ID." }, { "info": { "name": "Update payer plan group", "type": "http" }, "http": { "method": "PUT", "url": "https://pre-api.joincandidhealth.com/api/payer-plan-groups/v1/:payer_plan_group_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "payer_plan_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update any of the fields on a payer plan group" }, { "info": { "name": "Delete payer plan group", "type": "http" }, "http": { "method": "PATCH", "url": "https://pre-api.joincandidhealth.com/api/payer-plan-groups/v1/:payer_plan_group_id", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "payer_plan_group_id", "value": "", "type": "path" } ] }, "docs": "Marks the payer plan group as deactivated" } ] } ], "bundled": true }