For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • POSTCreate facility credentialing span
        • GETGet facility credentialing span
        • GETGet all facility credentialing spans
        • DELDelete facility credentialing span
        • PATCHUpdate facility credentialing span
        • POSTCreate provider credentialing span
        • GETGet provider credentialing span
        • GETGet all provider credentialing spans
        • DELDelete provider credentialing span
        • PATCHUpdate provider credentialing span
Contact Sales
LogoLogo
API ReferenceCredentialingV2

Get all provider credentialing spans

GET
/api/provider-credentialing-span/v2
GET
/api/provider-credentialing-span/v2
$curl https://api.joincandidhealth.com/api/provider-credentialing-span/v2 \
>     -H "Authorization: Bearer <token>"
1{
2  "items": [
3    {
4      "contracting_provider": {
5        "npi": "npi",
6        "is_rendering": true,
7        "is_billing": true,
8        "provider_type": "INDIVIDUAL",
9        "license_type": "MD",
10        "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
11        "qualifications": [
12          {
13            "identifier_code": "MCR",
14            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
15            "identifier_value": {
16              "type": "medicare_provider_identifier",
17              "provider_number": "provider_number",
18              "state": "AA"
19            },
20            "period": {
21              "start_date": "start_date",
22              "end_date": "end_date"
23            }
24          },
25          {
26            "identifier_code": "MCR",
27            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
28            "identifier_value": {
29              "type": "medicare_provider_identifier",
30              "provider_number": "provider_number",
31              "state": "AA"
32            },
33            "period": {
34              "start_date": "start_date",
35              "end_date": "end_date"
36            }
37          }
38        ],
39        "first_name": "first_name",
40        "last_name": "last_name",
41        "organization_name": "organization_name",
42        "tax_id": "tax_id",
43        "taxonomy_code": "taxonomy_code",
44        "addresses": [
45          {
46            "address": {
47              "address1": "address1",
48              "city": "city",
49              "state": "AA",
50              "zip_code": "zip_code",
51              "zip_plus_four_code": "zip_plus_four_code",
52              "address2": "address2"
53            },
54            "address_type": "DEFAULT"
55          },
56          {
57            "address": {
58              "address1": "address1",
59              "city": "city",
60              "state": "AA",
61              "zip_code": "zip_code",
62              "zip_plus_four_code": "zip_plus_four_code",
63              "address2": "address2"
64            },
65            "address_type": "DEFAULT"
66          }
67        ],
68        "employment_start_date": "2023-01-15",
69        "employment_termination_date": "2023-01-15"
70      },
71      "credentialing_status": "work_in_progress",
72      "is_enabled": true,
73      "payer": {
74        "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
75        "payer_id": "payer_id",
76        "payer_name": "payer_name",
77        "availity_payer_name": "availity_payer_name",
78        "availity_claims_payer_id": "availity_claims_payer_id",
79        "availity_eligibility_id": "availity_eligibility_id",
80        "availity_remittance_payer_id": "availity_remittance_payer_id",
81        "street_address": {
82          "address1": "address1",
83          "city": "city",
84          "state": "AA",
85          "zip_code": "zip_code",
86          "zip_plus_four_code": "zip_plus_four_code",
87          "address2": "address2"
88        }
89      },
90      "provider_credentialing_span_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
91      "regions": {
92        "type": "states",
93        "states": [
94          "AA",
95          "AA"
96        ]
97      },
98      "rendering_provider": {
99        "npi": "npi",
100        "is_rendering": true,
101        "is_billing": true,
102        "provider_type": "INDIVIDUAL",
103        "license_type": "MD",
104        "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
105        "qualifications": [
106          {
107            "identifier_code": "MCR",
108            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
109            "identifier_value": {
110              "type": "medicare_provider_identifier",
111              "provider_number": "provider_number",
112              "state": "AA"
113            },
114            "period": {
115              "start_date": "start_date",
116              "end_date": "end_date"
117            }
118          },
119          {
120            "identifier_code": "MCR",
121            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
122            "identifier_value": {
123              "type": "medicare_provider_identifier",
124              "provider_number": "provider_number",
125              "state": "AA"
126            },
127            "period": {
128              "start_date": "start_date",
129              "end_date": "end_date"
130            }
131          }
132        ],
133        "first_name": "first_name",
134        "last_name": "last_name",
135        "organization_name": "organization_name",
136        "tax_id": "tax_id",
137        "taxonomy_code": "taxonomy_code",
138        "addresses": [
139          {
140            "address": {
141              "address1": "address1",
142              "city": "city",
143              "state": "AA",
144              "zip_code": "zip_code",
145              "zip_plus_four_code": "zip_plus_four_code",
146              "address2": "address2"
147            },
148            "address_type": "DEFAULT"
149          },
150          {
151            "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            "address_type": "DEFAULT"
160          }
161        ],
162        "employment_start_date": "2023-01-15",
163        "employment_termination_date": "2023-01-15"
164      },
165      "source": "source",
166      "end_date": "2023-01-15",
167      "medallion_payer_enrollment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
168      "payer_loaded_date": "2023-01-15",
169      "start_date": "2023-01-15",
170      "submitted_date": "2023-01-15"
171    },
172    {
173      "contracting_provider": {
174        "npi": "npi",
175        "is_rendering": true,
176        "is_billing": true,
177        "provider_type": "INDIVIDUAL",
178        "license_type": "MD",
179        "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
180        "qualifications": [
181          {
182            "identifier_code": "MCR",
183            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
184            "identifier_value": {
185              "type": "medicare_provider_identifier",
186              "provider_number": "provider_number",
187              "state": "AA"
188            },
189            "period": {
190              "start_date": "start_date",
191              "end_date": "end_date"
192            }
193          },
194          {
195            "identifier_code": "MCR",
196            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
197            "identifier_value": {
198              "type": "medicare_provider_identifier",
199              "provider_number": "provider_number",
200              "state": "AA"
201            },
202            "period": {
203              "start_date": "start_date",
204              "end_date": "end_date"
205            }
206          }
207        ],
208        "first_name": "first_name",
209        "last_name": "last_name",
210        "organization_name": "organization_name",
211        "tax_id": "tax_id",
212        "taxonomy_code": "taxonomy_code",
213        "addresses": [
214          {
215            "address": {
216              "address1": "address1",
217              "city": "city",
218              "state": "AA",
219              "zip_code": "zip_code",
220              "zip_plus_four_code": "zip_plus_four_code",
221              "address2": "address2"
222            },
223            "address_type": "DEFAULT"
224          },
225          {
226            "address": {
227              "address1": "address1",
228              "city": "city",
229              "state": "AA",
230              "zip_code": "zip_code",
231              "zip_plus_four_code": "zip_plus_four_code",
232              "address2": "address2"
233            },
234            "address_type": "DEFAULT"
235          }
236        ],
237        "employment_start_date": "2023-01-15",
238        "employment_termination_date": "2023-01-15"
239      },
240      "credentialing_status": "work_in_progress",
241      "is_enabled": true,
242      "payer": {
243        "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
244        "payer_id": "payer_id",
245        "payer_name": "payer_name",
246        "availity_payer_name": "availity_payer_name",
247        "availity_claims_payer_id": "availity_claims_payer_id",
248        "availity_eligibility_id": "availity_eligibility_id",
249        "availity_remittance_payer_id": "availity_remittance_payer_id",
250        "street_address": {
251          "address1": "address1",
252          "city": "city",
253          "state": "AA",
254          "zip_code": "zip_code",
255          "zip_plus_four_code": "zip_plus_four_code",
256          "address2": "address2"
257        }
258      },
259      "provider_credentialing_span_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
260      "regions": {
261        "type": "states",
262        "states": [
263          "AA",
264          "AA"
265        ]
266      },
267      "rendering_provider": {
268        "npi": "npi",
269        "is_rendering": true,
270        "is_billing": true,
271        "provider_type": "INDIVIDUAL",
272        "license_type": "MD",
273        "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
274        "qualifications": [
275          {
276            "identifier_code": "MCR",
277            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
278            "identifier_value": {
279              "type": "medicare_provider_identifier",
280              "provider_number": "provider_number",
281              "state": "AA"
282            },
283            "period": {
284              "start_date": "start_date",
285              "end_date": "end_date"
286            }
287          },
288          {
289            "identifier_code": "MCR",
290            "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
291            "identifier_value": {
292              "type": "medicare_provider_identifier",
293              "provider_number": "provider_number",
294              "state": "AA"
295            },
296            "period": {
297              "start_date": "start_date",
298              "end_date": "end_date"
299            }
300          }
301        ],
302        "first_name": "first_name",
303        "last_name": "last_name",
304        "organization_name": "organization_name",
305        "tax_id": "tax_id",
306        "taxonomy_code": "taxonomy_code",
307        "addresses": [
308          {
309            "address": {
310              "address1": "address1",
311              "city": "city",
312              "state": "AA",
313              "zip_code": "zip_code",
314              "zip_plus_four_code": "zip_plus_four_code",
315              "address2": "address2"
316            },
317            "address_type": "DEFAULT"
318          },
319          {
320            "address": {
321              "address1": "address1",
322              "city": "city",
323              "state": "AA",
324              "zip_code": "zip_code",
325              "zip_plus_four_code": "zip_plus_four_code",
326              "address2": "address2"
327            },
328            "address_type": "DEFAULT"
329          }
330        ],
331        "employment_start_date": "2023-01-15",
332        "employment_termination_date": "2023-01-15"
333      },
334      "source": "source",
335      "end_date": "2023-01-15",
336      "medallion_payer_enrollment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
337      "payer_loaded_date": "2023-01-15",
338      "start_date": "2023-01-15",
339      "submitted_date": "2023-01-15"
340    }
341  ],
342  "next_page_token": "next_page_token",
343  "prev_page_token": "prev_page_token"
344}
Was this page helpful?
Previous

Delete provider credentialing span

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

limitintegerOptional
Maximum number of entities per page, defaults to 100.
page_tokenstringOptional
payer_uuidUUIDOptional
Filter by payer.
provider_idUUIDOptional

Filter to a particular provider. Use in conjunction as_rendering_provider and as_contracting_provider.

as_rendering_providerbooleanOptional

Filter to credentialing spans where the provider is a rendering provider. To use this filter provider_id is required.

as_contracting_providerbooleanOptional

Filter to credentialing spans where the provider is a contracting provider. To use this filter provider_id is required.

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstring
prev_page_tokenstring

Errors

403
Unauthorized Error
422
Unprocessable Entity Error