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