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
          • PUTUpdate
          • GETGet Multi Paginated
          • GETGet
          • GETGet History
          • GETGet Multi
          • GETScan
          • POSTBatch Update Ppg
          • POSTCheck Eligibility
          • GETGet Eligibility
Contact Sales
LogoLogo
API ReferencePre EncounterCoveragesV1

Get Multi Paginated

Beta
GET
/coverages/v1//get-multi-paginated
GET
/coverages/v1//get-multi-paginated
$curl https://pre-api.joincandidhealth.com/coverages/v1/get-multi-paginated \
>     -H "Authorization: Bearer <token>"
1{
2  "items": [
3    {
4      "deactivated": true,
5      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
6      "insurance_plan": {
7        "member_id": "member_id",
8        "payer_id": "payer_id",
9        "payer_name": "payer_name",
10        "additional_payer_information": {
11          "availity_eligibility_id": "availity_eligibility_id",
12          "availity_payer_id": "availity_payer_id",
13          "availity_payer_name": "availity_payer_name",
14          "availity_remittance_payer_id": "availity_remittance_payer_id"
15        },
16        "group_number": "group_number",
17        "name": "name",
18        "plan_type": "09",
19        "type": "01",
20        "period": {
21          "start": "2023-01-15",
22          "end": "2023-01-15"
23        },
24        "insurance_card_image_locator": "insurance_card_image_locator",
25        "address": {
26          "use": "HOME",
27          "line": [
28            "line",
29            "line"
30          ],
31          "city": "city",
32          "state": "state",
33          "postal_code": "postal_code",
34          "country": "country",
35          "county": "county",
36          "period": {
37            "start": "2023-01-15",
38            "end": "2023-01-15"
39          }
40        },
41        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
42        "carve_outs": [
43          {
44            "carve_out": "BEHAVIORAL",
45            "member_id": "member_id",
46            "payer_id": "payer_id",
47            "payer_name": "payer_name",
48            "group_number": "group_number",
49            "plan_type": "09",
50            "type": "01",
51            "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
52          },
53          {
54            "carve_out": "BEHAVIORAL",
55            "member_id": "member_id",
56            "payer_id": "payer_id",
57            "payer_name": "payer_name",
58            "group_number": "group_number",
59            "plan_type": "09",
60            "type": "01",
61            "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
62          }
63        ]
64      },
65      "organization_id": "organization_id",
66      "patient": "patient",
67      "relationship": "SELF",
68      "status": "ACTIVE",
69      "subscriber": {
70        "name": {
71          "family": "family",
72          "given": [
73            "given",
74            "given"
75          ],
76          "use": "USUAL",
77          "period": {
78            "start": "2023-01-15",
79            "end": "2023-01-15"
80          },
81          "suffix": "suffix"
82        },
83        "biological_sex": "FEMALE",
84        "date_of_birth": "2023-01-15",
85        "address": {
86          "use": "HOME",
87          "line": [
88            "line",
89            "line"
90          ],
91          "city": "city",
92          "state": "state",
93          "postal_code": "postal_code",
94          "country": "country",
95          "county": "county",
96          "period": {
97            "start": "2023-01-15",
98            "end": "2023-01-15"
99          }
100        },
101        "employer_name": "employer_name"
102      },
103      "updated_at": "2024-01-15T09:30:00Z",
104      "updating_user_id": "updating_user_id",
105      "verified": true,
106      "version": 1,
107      "auto_update_enabled": true,
108      "benefits": {
109        "plan_coverage": {
110          "in_network": {
111            "deductible": {},
112            "deductible_contract": {},
113            "deductible_remaining": {},
114            "deductible_year_to_date": {},
115            "oop_max": {},
116            "oop_max_contract": {},
117            "oop_max_remaining": {},
118            "oop_max_year_to_date": {},
119            "additional_notes": "additional_notes"
120          },
121          "in_network_flat": [
122            {
123              "type": "DEDUCTIBLE",
124              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
125              "unit": "PERCENT",
126              "value": 1.1
127            },
128            {
129              "type": "DEDUCTIBLE",
130              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
131              "unit": "PERCENT",
132              "value": 1.1
133            }
134          ],
135          "out_of_network": {
136            "deductible": {},
137            "deductible_contract": {},
138            "deductible_remaining": {},
139            "deductible_year_to_date": {},
140            "oop_max": {},
141            "oop_max_contract": {},
142            "oop_max_remaining": {},
143            "oop_max_year_to_date": {},
144            "additional_notes": "additional_notes"
145          },
146          "out_of_network_flat": [
147            {
148              "type": "DEDUCTIBLE",
149              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
150              "unit": "PERCENT",
151              "value": 1.1
152            },
153            {
154              "type": "DEDUCTIBLE",
155              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
156              "unit": "PERCENT",
157              "value": 1.1
158            }
159          ]
160        },
161        "service_specific_coverage": [
162          {
163            "service_code": "1",
164            "in_network": {},
165            "in_network_flat": [],
166            "out_of_network": {},
167            "out_of_network_flat": []
168          },
169          {
170            "service_code": "1",
171            "in_network": {},
172            "in_network_flat": [],
173            "out_of_network": {},
174            "out_of_network_flat": []
175          }
176        ],
177        "benefits_related_entities": [
178          {
179            "entityIdentifier": "entityIdentifier",
180            "entityType": "entityType",
181            "entityName": "entityName",
182            "contactInformation": [
183              {},
184              {}
185            ],
186            "serviceTypeCodes": [
187              "1",
188              "1"
189            ]
190          },
191          {
192            "entityIdentifier": "entityIdentifier",
193            "entityType": "entityType",
194            "entityName": "entityName",
195            "contactInformation": [
196              {},
197              {}
198            ],
199            "serviceTypeCodes": [
200              "1",
201              "1"
202            ]
203          }
204        ],
205        "non_covered_details": [
206          {
207            "type": "DEDUCTIBLE",
208            "coverageLevel": "EMPLOYEE_AND_CHILDREN",
209            "unit": "PERCENT",
210            "value": 1.1,
211            "additional_notes": "additional_notes",
212            "service_type_codes": [
213              "1",
214              "1"
215            ]
216          },
217          {
218            "type": "DEDUCTIBLE",
219            "coverageLevel": "EMPLOYEE_AND_CHILDREN",
220            "unit": "PERCENT",
221            "value": 1.1,
222            "additional_notes": "additional_notes",
223            "service_type_codes": [
224              "1",
225              "1"
226            ]
227          }
228        ],
229        "notes": "notes",
230        "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId"
231      },
232      "eligibility_checks": [
233        {
234          "check_id": "check_id",
235          "service_code": "1",
236          "status": "COMPLETED",
237          "initiated_by": "initiated_by",
238          "initiated_at": "2024-01-15T09:30:00Z"
239        },
240        {
241          "check_id": "check_id",
242          "service_code": "1",
243          "status": "COMPLETED",
244          "initiated_by": "initiated_by",
245          "initiated_at": "2024-01-15T09:30:00Z"
246        }
247      ],
248      "latest_eligibility_check": {
249        "check_id": "check_id",
250        "status": "ACTIVE",
251        "initiated_at": "2024-01-15T09:30:00Z",
252        "errors": [
253          {
254            "field?": "field?",
255            "description?": "description?",
256            "location?": "location?",
257            "possibleResolutions?": "possibleResolutions?",
258            "code?": "code?",
259            "followupAction?": "followupAction?"
260          },
261          {
262            "field?": "field?",
263            "description?": "description?",
264            "location?": "location?",
265            "possibleResolutions?": "possibleResolutions?",
266            "code?": "code?",
267            "followupAction?": "followupAction?"
268          }
269        ]
270      },
271      "orcon": true,
272      "previous_appointment_copays": {
273        "MD_Visit": 1
274      }
275    },
276    {
277      "deactivated": true,
278      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
279      "insurance_plan": {
280        "member_id": "member_id",
281        "payer_id": "payer_id",
282        "payer_name": "payer_name",
283        "additional_payer_information": {
284          "availity_eligibility_id": "availity_eligibility_id",
285          "availity_payer_id": "availity_payer_id",
286          "availity_payer_name": "availity_payer_name",
287          "availity_remittance_payer_id": "availity_remittance_payer_id"
288        },
289        "group_number": "group_number",
290        "name": "name",
291        "plan_type": "09",
292        "type": "01",
293        "period": {
294          "start": "2023-01-15",
295          "end": "2023-01-15"
296        },
297        "insurance_card_image_locator": "insurance_card_image_locator",
298        "address": {
299          "use": "HOME",
300          "line": [
301            "line",
302            "line"
303          ],
304          "city": "city",
305          "state": "state",
306          "postal_code": "postal_code",
307          "country": "country",
308          "county": "county",
309          "period": {
310            "start": "2023-01-15",
311            "end": "2023-01-15"
312          }
313        },
314        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
315        "carve_outs": [
316          {
317            "carve_out": "BEHAVIORAL",
318            "member_id": "member_id",
319            "payer_id": "payer_id",
320            "payer_name": "payer_name",
321            "group_number": "group_number",
322            "plan_type": "09",
323            "type": "01",
324            "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
325          },
326          {
327            "carve_out": "BEHAVIORAL",
328            "member_id": "member_id",
329            "payer_id": "payer_id",
330            "payer_name": "payer_name",
331            "group_number": "group_number",
332            "plan_type": "09",
333            "type": "01",
334            "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
335          }
336        ]
337      },
338      "organization_id": "organization_id",
339      "patient": "patient",
340      "relationship": "SELF",
341      "status": "ACTIVE",
342      "subscriber": {
343        "name": {
344          "family": "family",
345          "given": [
346            "given",
347            "given"
348          ],
349          "use": "USUAL",
350          "period": {
351            "start": "2023-01-15",
352            "end": "2023-01-15"
353          },
354          "suffix": "suffix"
355        },
356        "biological_sex": "FEMALE",
357        "date_of_birth": "2023-01-15",
358        "address": {
359          "use": "HOME",
360          "line": [
361            "line",
362            "line"
363          ],
364          "city": "city",
365          "state": "state",
366          "postal_code": "postal_code",
367          "country": "country",
368          "county": "county",
369          "period": {
370            "start": "2023-01-15",
371            "end": "2023-01-15"
372          }
373        },
374        "employer_name": "employer_name"
375      },
376      "updated_at": "2024-01-15T09:30:00Z",
377      "updating_user_id": "updating_user_id",
378      "verified": true,
379      "version": 1,
380      "auto_update_enabled": true,
381      "benefits": {
382        "plan_coverage": {
383          "in_network": {
384            "deductible": {},
385            "deductible_contract": {},
386            "deductible_remaining": {},
387            "deductible_year_to_date": {},
388            "oop_max": {},
389            "oop_max_contract": {},
390            "oop_max_remaining": {},
391            "oop_max_year_to_date": {},
392            "additional_notes": "additional_notes"
393          },
394          "in_network_flat": [
395            {
396              "type": "DEDUCTIBLE",
397              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
398              "unit": "PERCENT",
399              "value": 1.1
400            },
401            {
402              "type": "DEDUCTIBLE",
403              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
404              "unit": "PERCENT",
405              "value": 1.1
406            }
407          ],
408          "out_of_network": {
409            "deductible": {},
410            "deductible_contract": {},
411            "deductible_remaining": {},
412            "deductible_year_to_date": {},
413            "oop_max": {},
414            "oop_max_contract": {},
415            "oop_max_remaining": {},
416            "oop_max_year_to_date": {},
417            "additional_notes": "additional_notes"
418          },
419          "out_of_network_flat": [
420            {
421              "type": "DEDUCTIBLE",
422              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
423              "unit": "PERCENT",
424              "value": 1.1
425            },
426            {
427              "type": "DEDUCTIBLE",
428              "coverageLevel": "EMPLOYEE_AND_CHILDREN",
429              "unit": "PERCENT",
430              "value": 1.1
431            }
432          ]
433        },
434        "service_specific_coverage": [
435          {
436            "service_code": "1",
437            "in_network": {},
438            "in_network_flat": [],
439            "out_of_network": {},
440            "out_of_network_flat": []
441          },
442          {
443            "service_code": "1",
444            "in_network": {},
445            "in_network_flat": [],
446            "out_of_network": {},
447            "out_of_network_flat": []
448          }
449        ],
450        "benefits_related_entities": [
451          {
452            "entityIdentifier": "entityIdentifier",
453            "entityType": "entityType",
454            "entityName": "entityName",
455            "contactInformation": [
456              {},
457              {}
458            ],
459            "serviceTypeCodes": [
460              "1",
461              "1"
462            ]
463          },
464          {
465            "entityIdentifier": "entityIdentifier",
466            "entityType": "entityType",
467            "entityName": "entityName",
468            "contactInformation": [
469              {},
470              {}
471            ],
472            "serviceTypeCodes": [
473              "1",
474              "1"
475            ]
476          }
477        ],
478        "non_covered_details": [
479          {
480            "type": "DEDUCTIBLE",
481            "coverageLevel": "EMPLOYEE_AND_CHILDREN",
482            "unit": "PERCENT",
483            "value": 1.1,
484            "additional_notes": "additional_notes",
485            "service_type_codes": [
486              "1",
487              "1"
488            ]
489          },
490          {
491            "type": "DEDUCTIBLE",
492            "coverageLevel": "EMPLOYEE_AND_CHILDREN",
493            "unit": "PERCENT",
494            "value": 1.1,
495            "additional_notes": "additional_notes",
496            "service_type_codes": [
497              "1",
498              "1"
499            ]
500          }
501        ],
502        "notes": "notes",
503        "autoUpdatedEligibilityCheckId": "autoUpdatedEligibilityCheckId"
504      },
505      "eligibility_checks": [
506        {
507          "check_id": "check_id",
508          "service_code": "1",
509          "status": "COMPLETED",
510          "initiated_by": "initiated_by",
511          "initiated_at": "2024-01-15T09:30:00Z"
512        },
513        {
514          "check_id": "check_id",
515          "service_code": "1",
516          "status": "COMPLETED",
517          "initiated_by": "initiated_by",
518          "initiated_at": "2024-01-15T09:30:00Z"
519        }
520      ],
521      "latest_eligibility_check": {
522        "check_id": "check_id",
523        "status": "ACTIVE",
524        "initiated_at": "2024-01-15T09:30:00Z",
525        "errors": [
526          {
527            "field?": "field?",
528            "description?": "description?",
529            "location?": "location?",
530            "possibleResolutions?": "possibleResolutions?",
531            "code?": "code?",
532            "followupAction?": "followupAction?"
533          },
534          {
535            "field?": "field?",
536            "description?": "description?",
537            "location?": "location?",
538            "possibleResolutions?": "possibleResolutions?",
539            "code?": "code?",
540            "followupAction?": "followupAction?"
541          }
542        ]
543      },
544      "orcon": true,
545      "previous_appointment_copays": {
546        "MD_Visit": 1
547      }
548    }
549  ],
550  "total": 1,
551  "next_page_token": "next_page_token",
552  "prev_page_token": "prev_page_token"
553}
Returns a page of Coverages based on the search criteria.
Was this page helpful?
Previous

Get

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

patient_idstringOptional
payer_plan_group_idstringOptional
page_tokenstringOptional
A token that can be used to retrieve the next or previous page of results
limitintegerOptional
Must be between 0 and 1000. Defaults to 100

Response

This endpoint returns an object.
itemslist of objects
totalinteger
next_page_tokenstring
A token that can be used to retrieve the next or previous page of results
prev_page_tokenstring
A token that can be used to retrieve the next or previous page of results

Errors

400
Bad Request Error