ContractsV2

Get all contracts

Beta

GET

Query parameters

page_tokenstringOptional

limitintegerOptional

Max number of contracts returned. Defaults to 1000. Max is 1000.

contracting_provider_idUUIDOptional

rendering_provider_idsUUIDOptional

payer_namesstringOptional

Filter to contracts that include any of the included payer names.

statesenumOptional

contract_statusenumOptional

The status of the contract. Defaults to pending

Allowed values: pendingeffectivecancelled

Response

This endpoint returns an object

items

list of objects

next_page_token

stringOptional

prev_page_token

stringOptional

GET

1 curl -G https://api.joincandidhealth.com/api/contracts/v2 \
2      -H "Authorization: Bearer <token>" \
3      -d page_token=string \
4      -d limit=0

200Retrieved

1 {
2   "items": [
3     {
4       "commercial_insurance_types": {
5         "type": "allApply"
6       },
7       "contract_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8       "contracting_provider": {
9         "employment_status": "ACTIVE",
10         "is_billing": true,
11         "is_rendering": true,
12         "license_type": "MD",
13         "npi": "string",
14         "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15         "provider_type": "INDIVIDUAL",
16         "addresses": [
17           {
18             "address": {
19               "address1": "string",
20               "city": "string",
21               "state": "AA",
22               "zip_code": "string",
23               "zip_plus_four_code": "string",
24               "address2": "string"
25             },
26             "address_type": "DEFAULT"
27           }
28         ],
29         "employment_start_date": "string",
30         "employment_termination_date": "string",
31         "first_name": "string",
32         "last_name": "string",
33         "medicaid_provider_id": "string",
34         "organization_name": "string",
35         "ptan": "string",
36         "tax_id": "string",
37         "taxonomy_code": "string"
38       },
39       "effective_date": "string",
40       "medicaid_insurance_types": {
41         "type": "allApply"
42       },
43       "medicare_insurance_types": {
44         "type": "allApply"
45       },
46       "payer": {
47         "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
48         "payer_id": "string",
49         "payer_name": "string"
50       },
51       "provider_count": 0,
52       "regions": {
53         "type": "states",
54         "states": [
55           "AA"
56         ]
57       },
58       "authorized_signatory": {
59         "first_name": "string",
60         "last_name": "string",
61         "title": "string",
62         "email": "string",
63         "phone": "string",
64         "fax": "string"
65       },
66       "contract_status": "pending",
67       "expiration_date": "string"
68     }
69   ],
70   "next_page_token": "string",
71   "prev_page_token": "string"
72 }

Built with

1	curl -G https://api.joincandidhealth.com/api/contracts/v2 \
2	-H "Authorization: Bearer <token>" \
3	-d page_token=string \
4	-d limit=0

1	{
2	"items": [
3	{
4	"commercial_insurance_types": {
5	"type": "allApply"
6	},
7	"contract_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8	"contracting_provider": {
9	"employment_status": "ACTIVE",
10	"is_billing": true,
11	"is_rendering": true,
12	"license_type": "MD",
13	"npi": "string",
14	"organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15	"provider_type": "INDIVIDUAL",
16	"addresses": [
17	{
18	"address": {
19	"address1": "string",
20	"city": "string",
21	"state": "AA",
22	"zip_code": "string",
23	"zip_plus_four_code": "string",
24	"address2": "string"
25	},
26	"address_type": "DEFAULT"
27	}
28	],
29	"employment_start_date": "string",
30	"employment_termination_date": "string",
31	"first_name": "string",
32	"last_name": "string",
33	"medicaid_provider_id": "string",
34	"organization_name": "string",
35	"ptan": "string",
36	"tax_id": "string",
37	"taxonomy_code": "string"
38	},
39	"effective_date": "string",
40	"medicaid_insurance_types": {
41	"type": "allApply"
42	},
43	"medicare_insurance_types": {
44	"type": "allApply"
45	},
46	"payer": {
47	"payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
48	"payer_id": "string",
49	"payer_name": "string"
50	},
51	"provider_count": 0,
52	"regions": {
53	"type": "states",
54	"states": [
55	"AA"
56	]
57	},
58	"authorized_signatory": {
59	"first_name": "string",
60	"last_name": "string",
61	"title": "string",
62	"email": "string",
63	"phone": "string",
64	"fax": "string"
65	},
66	"contract_status": "pending",
67	"expiration_date": "string"
68	}
69	],
70	"next_page_token": "string",
71	"prev_page_token": "string"
72	}