> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server. # Get contract GET https://api.joincandidhealth.com/api/contracts/v2/{contract_id} This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3. Reference: https://docs.joincandidhealth.com/api-reference/contracts/v-2/get ## Authentication - OAuth2 — send the obtained token as `Authorization: Bearer ` ## Servers - `https://api.joincandidhealth.com` (Production, default) - `https://api-staging.joincandidhealth.com` (Staging) - `https://sandbox-api.joincandidhealth.com` (CandidSandbox) - `https://staging-api.joincandidhealth.com` (CandidStaging) - `http://localhost:5050` (Local) ## Request ### Path parameters - `contract_id` (UUID, required) ### Query parameters - `organization_id` (UUID, optional) — Organization context for cross-org access. If not provided, defaults to the requesting user's organization. ## Response ### 200 - `commercial_insurance_types` (InsuranceTypes, required) — The commercial plan insurance types this contract applies. - `contract_id` (UUID, required) - `contracting_provider` (OrganizationProvider, required) — The provider under contract - `effective_date` (string, required) — The starting day upon which the contract is effective - `medicaid_insurance_types` (InsuranceTypes, required) — The Medicaid plan insurance types this contract applies. - `medicare_insurance_types` (InsuranceTypes, required) — The Medicare plan insurance types this contract applies. - `payer` (Payer, required) — The insurance company under contract - `provider_count` (integer, required) — The number of linked providers who can render medical services under this contract - `regions` (Regions, required) — The state(s) to which the contract's coverage extends. It may also be set to "national" for the entirety of the US. - `rendering_provider_ids` (set of UUID, required) — The providers who can render medical services under the contract - `authorized_signatory` (AuthorizedSignatory, optional) - `contract_status` (enum, optional) - Allowed values: `pending`, `effective`, `cancelled` - `expiration_date` (string, optional) — An optional end day upon which the contract expires ## Errors ### 404 Entity Not Found Error - `errorName` ("EntityNotFoundError", required) - `content` (EntityNotFoundErrorMessage, required) ## Types ### InsuranceTypes - `type`: `allApply` - `type`: `noneApply` - `type`: `theseApply` - `value` (set of enum, required) - Allowed values: `01`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `41`, `42`, `43`, `47`, `AP`, `C1`, `CO`, `CP`, `D`, `DB`, `E`, `EP`, `FF`, `GP`, `HA`, `HB`, `HD`, `HG`, `HM`, `HN`, `HP`, `HS`, `IN`, `IP`, `LC`, `LD`, `LI`, `LT`, `M`, `MA`, `MB`, `MC`, `MD`, `ME`, `MF`, `MH`, `MI`, `MJ`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`, `MR`, `MT`, `MV`, `OA`, `OT`, `PE`, `PL`, `PP`, `PR`, `PS`, `QM`, `RP`, `SP`, `TF`, `U`, `WC`, `WU` ### OrganizationProvider - `employment_status` (enum, required) — The employment status for the provider. - Allowed values: `ACTIVE`, `TERMINATED` - `is_billing` (boolean, required) — Whether the provider can be used to bill services. - `is_rendering` (boolean, required) — Whether the provider can be used to render services. - `license_type` (enum, required) — The type of license that the provider holds. - Allowed values: `MD`, `NP`, `PA`, `LMFT`, `LCPC`, `LCSW`, `PMHNP`, `FNP`, `LPCC`, `DO`, `RD`, `SLP`, `APRN`, `LPC`, `PHD`, `PSYD`, `LMSW`, `LMHC`, `OTHER_MASTERS`, `BCBA`, `UNKNOWN`, `RPH`, `PHT`, `LAC`, `LMT`, `DC`, `ND`, `MA`, `PT`, `IBCLC`, `RN`, `DPT`, `LCMHC`, `CNM`, `RNFA`, `ACSW`, `APC`, `BCABA`, `BHA`, `OD`, `DPM`, `DA`, `DDS`, `DEH`, `DMD`, `PTA`, `LCADC`, `LCAT`, `LCMHCS`, `LCMHCA`, `LCSWA`, `LICSW`, `LISW`, `LMFTS`, `LMFTA`, `LPCI`, `LSCSW`, `MHCA`, `MHT`, `RBT`, `RCSWI`, `RHMCI`, `LPN`, `OTD`, `OMS`, `MFTA`, `APCC`, `DNP`, `AGNPBC`, `ANP`, `FNPPP`, `LCSWR`, `ALC`, `RMFTI`, `LAMFT`, `LPCA`, `LSWI`, `CSW`, `CPC`, `LGMFT`, `LLPC`, `PLPC`, `PLMFT`, `LMHCA`, `CIT`, `CT`, `MFT`, `LSW`, `PLMHP`, `PCMSW`, `LMHP`, `OTR/L`, `RPA`, `COTA`, `CRNP`, `SLP-CF`, `NP-C`, `PA-C`, `AMFT`, `CDN`, `CGC`, `CNS`, `MDPHD`, `AuD`, `ATC`, `LAT`, `OTA`, `LSSP`, `SLPA`, `EdD`, `SWT`, `IMFT` - `npi` (string, required) — The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long. - `organization_provider_id` (UUID, required) — Auto-generated ID set on creation - `provider_type` (enum, required) — Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider. - Allowed values: `INDIVIDUAL`, `ORGANIZATION` - `addresses` (list of OrganizationProviderAddress, optional) — The addresses associated with this provider. - `employment_start_date` (string, optional) — The employment start date for the provider. - `employment_termination_date` (string, optional) — The employment termination date for the provider. - `first_name` (string, optional) — The first name of the provider, if the provider is an individual. - `last_name` (string, optional) — The last name of the provider, if the provider is an individual. - `medicaid_provider_id` (string, optional) — The medicaid provider ID for the provider. - `organization_name` (string, optional) — The name of the provider, if the provider is an organization. - `ptan` (string, optional) — The Provider Transaction Access Number for the provider. - `tax_id` (string, optional) — If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting. - `taxonomy_code` (string, optional) — A code designating classification and specialization. ### Payer - `payer_uuid` (UUID, required) — Auto-generated ID set on creation. - `payer_id` (string, required) — The primary national payer ID of the payer. - `payer_name` (string, required) — The primary display name of the payer. - `availity_payer_name` (string, optional) — The name of the payer as it appears in Availity. - `availity_claims_payer_id` (string, optional) — The ID of the payer as it appears in Availity. - `availity_eligibility_id` (string, optional) — The eligibility ID of the payer as it appears in Availity. - `availity_remittance_payer_id` (string, optional) — The remittance ID of the payer as it appears in Availity. - `street_address` (StreetAddressLongZip, optional) ### Regions - `type`: `states` - `states` (list of enum, required) - Allowed values: `AA`, `AE`, `AP`, `AL`, `AK`, `AS`, `AZ`, `AR`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MH`, `MI`, `MN`, `MP`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `OH`, `OK`, `OR`, `PA`, `PR`, `PW`, `RI`, `SC`, `SD`, `TN`, `TX`, `UT`, `VI`, `VT`, `VA`, `WA`, `WV`, `WI`, `WY`, `FC` - `type`: `national` ### AuthorizedSignatory - `first_name` (string, optional) - `last_name` (string, optional) - `title` (string, optional) - `email` (string, optional) - `phone` (string, optional) - `fax` (string, optional) ### EntityNotFoundErrorMessage - `id` (string, required) ### OrganizationProviderAddress - `address` (StreetAddressLongZip, required) — The address of the provider - `address_type` (enum, required) — The address type of the provider - Allowed values: `DEFAULT` ### StreetAddressLongZip - `address1` (string, required) - `city` (string, required) - `state` (enum, required) - Allowed values: `AA`, `AE`, `AP`, `AL`, `AK`, `AS`, `AZ`, `AR`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MH`, `MI`, `MN`, `MP`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `OH`, `OK`, `OR`, `PA`, `PR`, `PW`, `RI`, `SC`, `SD`, `TN`, `TX`, `UT`, `VI`, `VT`, `VA`, `WA`, `WV`, `WI`, `WY`, `FC` - `zip_code` (string, required) — 5-digit zip code - `zip_plus_four_code` (string, required) — 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 - `address2` (string, optional) ## Examples **Response** ```json { "commercial_insurance_types": { "type": "allApply" }, "contract_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "contracting_provider": { "employment_status": "ACTIVE", "is_billing": true, "is_rendering": true, "license_type": "MD", "npi": "npi", "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "provider_type": "INDIVIDUAL", "addresses": [ { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "address_type": "DEFAULT" }, { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "address_type": "DEFAULT" } ], "employment_start_date": "employment_start_date", "employment_termination_date": "employment_termination_date", "first_name": "first_name", "last_name": "last_name", "medicaid_provider_id": "medicaid_provider_id", "organization_name": "organization_name", "ptan": "ptan", "tax_id": "tax_id", "taxonomy_code": "taxonomy_code" }, "effective_date": "effective_date", "medicaid_insurance_types": { "type": "allApply" }, "medicare_insurance_types": { "type": "allApply" }, "payer": { "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "payer_id": "payer_id", "payer_name": "payer_name", "availity_payer_name": "availity_payer_name", "availity_claims_payer_id": "availity_claims_payer_id", "availity_eligibility_id": "availity_eligibility_id", "availity_remittance_payer_id": "availity_remittance_payer_id", "street_address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" } }, "provider_count": 1, "regions": { "type": "states", "states": [ "AA", "AA" ] }, "rendering_provider_ids": [ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" ], "authorized_signatory": { "first_name": "first_name", "last_name": "last_name", "title": "title", "email": "email", "phone": "phone", "fax": "fax" }, "contract_status": "pending", "expiration_date": "expiration_date" } ``` **SDK Code** ```python import requests url = "https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" headers = {"Authorization": "."} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'; const options = {method: 'GET', headers: {Authorization: '.'}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", ".") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = '.' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") .header("Authorization", ".") .asString(); ``` ```php request('GET', 'https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [ 'headers' => [ 'Authorization' => '.', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "."); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "."] let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/contracts/v2/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```