ContractsV2

Get all contracts

Beta
GET
https://api.joincandidhealth.com/api/contracts/v2

Query parameters

page_token
optional string
limit
optional integer
Max number of contracts returned. Defaults to 1000. Max is 1000.
contracting_provider_id
optional UUID
rendering_provider_ids
optional UUID
payer_names
optional string
Filter to contracts that include any of the included payer names.
states
optional enum
contract_status
optional enum

The status of the contract. Defaults to pending

Allowed values: pendingeffectivecancelled

Response

This endpoint return an object.
items
list of objects
next_page_token
optional string
prev_page_token
optional string
GET
/api/contracts/v2
curl -G https://api.joincandidhealth.com/api/contracts/v2 \
-H "Authorization: Bearer <token>" \
-d page_token=string \
-d limit=0
Response
{
"items": [
{
"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": "string",
"organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"provider_type": "INDIVIDUAL",
"addresses": [
{
"address": {
"address1": "string",
"city": "string",
"state": "AA",
"zip_code": "string",
"zip_plus_four_code": "string",
"address2": "string"
},
"address_type": "DEFAULT"
}
],
"employment_start_date": "string",
"employment_termination_date": "string",
"first_name": "string",
"last_name": "string",
"medicaid_provider_id": "string",
"organization_name": "string",
"ptan": "string",
"tax_id": "string",
"taxonomy_code": "string"
},
"effective_date": "string",
"medicaid_insurance_types": {
"type": "allApply"
},
"medicare_insurance_types": {
"type": "allApply"
},
"provider_count": 0,
"regions": {
"type": "states",
"states": [
"AA"
]
},
"authorized_signatory": {
"first_name": "string",
"last_name": "string",
"title": "string",
"email": "string",
"phone": "string",
"fax": "string"
},
"contract_status": "pending",
"expiration_date": "string",
"payer": {
"payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
"payer_id": "string",
"payer_name": "string"
}
}
],
"next_page_token": "string",
"prev_page_token": "string"
}