Get Multi Paginated

Beta

GET

/coverages/v1//get-multi-paginated

GET

/coverages/v1//get-multi-paginated

1 from candid import CandidApiClient
2 
3 client = CandidApiClient(
4     client_id="YOUR_CLIENT_ID",
5     client_secret="YOUR_CLIENT_SECRET",
6 )
7 client.pre_encounter.coverages.v_1.get_multi_paginated()

Try it

200Retrieved

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         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
26       },
27       "organization_id": "organization_id",
28       "patient": "patient",
29       "relationship": "SELF",
30       "status": "ACTIVE",
31       "subscriber": {
32         "name": {
33           "family": "family",
34           "given": [
35             "given",
36             "given"
37           ],
38           "use": "USUAL",
39           "period": {
40             "start": "2023-01-15",
41             "end": "2023-01-15"
42           },
43           "suffix": "suffix"
44         },
45         "date_of_birth": "2023-01-15",
46         "biological_sex": "FEMALE",
47         "address": {
48           "use": "HOME",
49           "line": [
50             "line",
51             "line"
52           ],
53           "city": "city",
54           "state": "state",
55           "postal_code": "postal_code",
56           "country": "country",
57           "period": {
58             "start": "2023-01-15",
59             "end": "2023-01-15"
60           }
61         }
62       },
63       "updated_at": "2024-01-15T09:30:00Z",
64       "updating_user_id": "updating_user_id",
65       "verified": true,
66       "version": 1,
67       "benefits": {
68         "plan_coverage": {
69           "in_network": {},
70           "in_network_flat": [],
71           "out_of_network": {},
72           "out_of_network_flat": []
73         },
74         "service_specific_coverage": [
75           {
76             "service_code": "1",
77             "in_network": {},
78             "in_network_flat": [],
79             "out_of_network": {},
80             "out_of_network_flat": []
81           },
82           {
83             "service_code": "1",
84             "in_network": {},
85             "in_network_flat": [],
86             "out_of_network": {},
87             "out_of_network_flat": []
88           }
89         ],
90         "benefits_related_entities": [
91           {
92             "entityIdentifier": "entityIdentifier",
93             "entityType": "entityType",
94             "entityName": "entityName",
95             "contactInformation": [],
96             "serviceTypeCodes": []
97           },
98           {
99             "entityIdentifier": "entityIdentifier",
100             "entityType": "entityType",
101             "entityName": "entityName",
102             "contactInformation": [],
103             "serviceTypeCodes": []
104           }
105         ],
106         "notes": "notes"
107       },
108       "eligibility_checks": [
109         {
110           "check_id": "check_id",
111           "service_code": "1",
112           "status": "COMPLETED",
113           "initiated_by": "initiated_by",
114           "initiated_at": "2024-01-15T09:30:00Z"
115         },
116         {
117           "check_id": "check_id",
118           "service_code": "1",
119           "status": "COMPLETED",
120           "initiated_by": "initiated_by",
121           "initiated_at": "2024-01-15T09:30:00Z"
122         }
123       ],
124       "latest_eligibility_check": {
125         "check_id": "check_id",
126         "status": "ACTIVE",
127         "initiated_at": "2024-01-15T09:30:00Z"
128       }
129     },
130     {
131       "deactivated": true,
132       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
133       "insurance_plan": {
134         "member_id": "member_id",
135         "payer_id": "payer_id",
136         "payer_name": "payer_name",
137         "additional_payer_information": {
138           "availity_eligibility_id": "availity_eligibility_id",
139           "availity_payer_id": "availity_payer_id",
140           "availity_payer_name": "availity_payer_name",
141           "availity_remittance_payer_id": "availity_remittance_payer_id"
142         },
143         "group_number": "group_number",
144         "name": "name",
145         "plan_type": "09",
146         "type": "01",
147         "period": {
148           "start": "2023-01-15",
149           "end": "2023-01-15"
150         },
151         "insurance_card_image_locator": "insurance_card_image_locator",
152         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
153       },
154       "organization_id": "organization_id",
155       "patient": "patient",
156       "relationship": "SELF",
157       "status": "ACTIVE",
158       "subscriber": {
159         "name": {
160           "family": "family",
161           "given": [
162             "given",
163             "given"
164           ],
165           "use": "USUAL",
166           "period": {
167             "start": "2023-01-15",
168             "end": "2023-01-15"
169           },
170           "suffix": "suffix"
171         },
172         "date_of_birth": "2023-01-15",
173         "biological_sex": "FEMALE",
174         "address": {
175           "use": "HOME",
176           "line": [
177             "line",
178             "line"
179           ],
180           "city": "city",
181           "state": "state",
182           "postal_code": "postal_code",
183           "country": "country",
184           "period": {
185             "start": "2023-01-15",
186             "end": "2023-01-15"
187           }
188         }
189       },
190       "updated_at": "2024-01-15T09:30:00Z",
191       "updating_user_id": "updating_user_id",
192       "verified": true,
193       "version": 1,
194       "benefits": {
195         "plan_coverage": {
196           "in_network": {},
197           "in_network_flat": [],
198           "out_of_network": {},
199           "out_of_network_flat": []
200         },
201         "service_specific_coverage": [
202           {
203             "service_code": "1",
204             "in_network": {},
205             "in_network_flat": [],
206             "out_of_network": {},
207             "out_of_network_flat": []
208           },
209           {
210             "service_code": "1",
211             "in_network": {},
212             "in_network_flat": [],
213             "out_of_network": {},
214             "out_of_network_flat": []
215           }
216         ],
217         "benefits_related_entities": [
218           {
219             "entityIdentifier": "entityIdentifier",
220             "entityType": "entityType",
221             "entityName": "entityName",
222             "contactInformation": [],
223             "serviceTypeCodes": []
224           },
225           {
226             "entityIdentifier": "entityIdentifier",
227             "entityType": "entityType",
228             "entityName": "entityName",
229             "contactInformation": [],
230             "serviceTypeCodes": []
231           }
232         ],
233         "notes": "notes"
234       },
235       "eligibility_checks": [
236         {
237           "check_id": "check_id",
238           "service_code": "1",
239           "status": "COMPLETED",
240           "initiated_by": "initiated_by",
241           "initiated_at": "2024-01-15T09:30:00Z"
242         },
243         {
244           "check_id": "check_id",
245           "service_code": "1",
246           "status": "COMPLETED",
247           "initiated_by": "initiated_by",
248           "initiated_at": "2024-01-15T09:30:00Z"
249         }
250       ],
251       "latest_eligibility_check": {
252         "check_id": "check_id",
253         "status": "ACTIVE",
254         "initiated_at": "2024-01-15T09:30:00Z"
255       }
256     }
257   ],
258   "total": 1,
259   "next_page_token": "next_page_token",
260   "prev_page_token": "prev_page_token"
261 }

Returns a page of Coverages based on the search criteria.

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 or null

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstring or null

A token that can be used to retrieve the next or previous page of results

Get Multi Paginated

Headers

Query parameters

Response

Errors