Get Multi

Beta

GET

/api/non-insurance-payers/v1

GET

/api/non-insurance-payers/v1

1 from candid import CandidApiClient
2 from candid.resources.commons import SortDirection
3 from candid.resources.non_insurance_payers.resources.v_1 import (
4     NonInsurancePayerSortField,
5 )
6 
7 client = CandidApiClient(
8     client_id="YOUR_CLIENT_ID",
9     client_secret="YOUR_CLIENT_SECRET",
10 )
11 client.non_insurance_payers.v_1.get_multi(
12     name="string",
13     category="string",
14     enabled=True,
15     sort=NonInsurancePayerSortField.NAME,
16     sort_direction=SortDirection.ASC,
17     limit=1,
18     page_token="eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
19 )

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5       "name": "string",
6       "enabled": true,
7       "clinical_trials": [
8         {
9           "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10           "clinical_trial_number": "string",
11           "is_active": true,
12           "name": "string",
13           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14           "clinical_trial_phase": "Phase 1"
15         }
16       ],
17       "description": "string",
18       "category": "string",
19       "address": {
20         "address1": "string",
21         "city": "string",
22         "state": "AA",
23         "zip_code": "string",
24         "address2": "string",
25         "zip_plus_four_code": "string"
26       }
27     }
28   ],
29   "next_page_token": "string",
30   "prev_page_token": "string"
31 }

Query parameters

namestringOptional

categorystringOptional

enabledbooleanOptional

sortenumOptional

Allowed values:

sort_directionenumOptional

Allowed values:

limitintegerOptional

Defaults to 100

page_tokenstringOptional

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Get Multi

Headers

Query parameters

Response

Errors