Get all contracts

Beta

GET

/api/contracts/v2

GET

/api/contracts/v2

1 from candid import CandidApiClient
2 
3 client = CandidApiClient(
4     client_id="YOUR_CLIENT_ID",
5     client_secret="YOUR_CLIENT_SECRET",
6 )
7 client.contracts.v_2.get_multi()

Try it

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": "npi",
14         "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15         "provider_type": "INDIVIDUAL",
16         "addresses": [
17           {
18             "address": {
19               "address1": "address1",
20               "city": "city",
21               "state": "AA",
22               "zip_code": "zip_code",
23               "zip_plus_four_code": "zip_plus_four_code"
24             },
25             "address_type": "DEFAULT"
26           },
27           {
28             "address": {
29               "address1": "address1",
30               "city": "city",
31               "state": "AA",
32               "zip_code": "zip_code",
33               "zip_plus_four_code": "zip_plus_four_code"
34             },
35             "address_type": "DEFAULT"
36           }
37         ],
38         "employment_start_date": "employment_start_date",
39         "employment_termination_date": "employment_termination_date",
40         "first_name": "first_name",
41         "last_name": "last_name",
42         "medicaid_provider_id": "medicaid_provider_id",
43         "organization_name": "organization_name",
44         "ptan": "ptan",
45         "tax_id": "tax_id",
46         "taxonomy_code": "taxonomy_code"
47       },
48       "effective_date": "effective_date",
49       "medicaid_insurance_types": {
50         "type": "allApply"
51       },
52       "medicare_insurance_types": {
53         "type": "allApply"
54       },
55       "payer": {
56         "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
57         "payer_id": "payer_id",
58         "payer_name": "payer_name",
59         "availity_payer_name": "availity_payer_name",
60         "availity_claims_payer_id": "availity_claims_payer_id",
61         "availity_eligibility_id": "availity_eligibility_id",
62         "availity_remittance_payer_id": "availity_remittance_payer_id",
63         "street_address": {
64           "address1": "address1",
65           "city": "city",
66           "state": "AA",
67           "zip_code": "zip_code",
68           "zip_plus_four_code": "zip_plus_four_code",
69           "address2": "address2"
70         }
71       },
72       "provider_count": 1,
73       "regions": {
74         "type": "states",
75         "states": [
76           "AA",
77           "AA"
78         ]
79       },
80       "authorized_signatory": {
81         "first_name": "first_name",
82         "last_name": "last_name",
83         "title": "title",
84         "email": "email",
85         "phone": "phone",
86         "fax": "fax"
87       },
88       "contract_status": "pending",
89       "expiration_date": "expiration_date"
90     },
91     {
92       "commercial_insurance_types": {
93         "type": "allApply"
94       },
95       "contract_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
96       "contracting_provider": {
97         "employment_status": "ACTIVE",
98         "is_billing": true,
99         "is_rendering": true,
100         "license_type": "MD",
101         "npi": "npi",
102         "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
103         "provider_type": "INDIVIDUAL",
104         "addresses": [
105           {
106             "address": {
107               "address1": "address1",
108               "city": "city",
109               "state": "AA",
110               "zip_code": "zip_code",
111               "zip_plus_four_code": "zip_plus_four_code"
112             },
113             "address_type": "DEFAULT"
114           },
115           {
116             "address": {
117               "address1": "address1",
118               "city": "city",
119               "state": "AA",
120               "zip_code": "zip_code",
121               "zip_plus_four_code": "zip_plus_four_code"
122             },
123             "address_type": "DEFAULT"
124           }
125         ],
126         "employment_start_date": "employment_start_date",
127         "employment_termination_date": "employment_termination_date",
128         "first_name": "first_name",
129         "last_name": "last_name",
130         "medicaid_provider_id": "medicaid_provider_id",
131         "organization_name": "organization_name",
132         "ptan": "ptan",
133         "tax_id": "tax_id",
134         "taxonomy_code": "taxonomy_code"
135       },
136       "effective_date": "effective_date",
137       "medicaid_insurance_types": {
138         "type": "allApply"
139       },
140       "medicare_insurance_types": {
141         "type": "allApply"
142       },
143       "payer": {
144         "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
145         "payer_id": "payer_id",
146         "payer_name": "payer_name",
147         "availity_payer_name": "availity_payer_name",
148         "availity_claims_payer_id": "availity_claims_payer_id",
149         "availity_eligibility_id": "availity_eligibility_id",
150         "availity_remittance_payer_id": "availity_remittance_payer_id",
151         "street_address": {
152           "address1": "address1",
153           "city": "city",
154           "state": "AA",
155           "zip_code": "zip_code",
156           "zip_plus_four_code": "zip_plus_four_code",
157           "address2": "address2"
158         }
159       },
160       "provider_count": 1,
161       "regions": {
162         "type": "states",
163         "states": [
164           "AA",
165           "AA"
166         ]
167       },
168       "authorized_signatory": {
169         "first_name": "first_name",
170         "last_name": "last_name",
171         "title": "title",
172         "email": "email",
173         "phone": "phone",
174         "fax": "fax"
175       },
176       "contract_status": "pending",
177       "expiration_date": "expiration_date"
178     }
179   ],
180   "next_page_token": "next_page_token",
181   "prev_page_token": "prev_page_token"
182 }

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:

sortenumOptional

Potentially sort by a contract related attribute. Defaults to created_at

sort_directionenumOptional

Direction of sort, defaulting to desc

Allowed values:

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstring or null

prev_page_tokenstring or null

Headers

Query parameters

Response