Get Patient

GET

/api/patients/v2/:id

GET

/api/patients/v2/:id

1 import requests
2 
3 url = "https://app.usebridge.com/api/patients/v2/id"
4 
5 headers = {"X-API-Key": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

200Retrieved

1 {
2   "id": "id",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "coverage": [
5     {
6       "id": "id",
7       "rank": 1,
8       "policyId": "policyId"
9     },
10     {
11       "id": "id",
12       "rank": 1,
13       "policyId": "policyId"
14     }
15   ],
16   "firstName": "firstName",
17   "lastName": "lastName",
18   "dateOfBirth": "2024-01-15T09:30:00Z",
19   "email": "email",
20   "patientToken": "patientToken",
21   "externalId": "externalId",
22   "phone": "phone",
23   "address": {
24     "state": "AL",
25     "line1": "line1",
26     "line2": "line2",
27     "city": "city",
28     "postalCode": "postalCode",
29     "country": "US"
30   },
31   "metadata": {
32     "exampleKey": "exampleKey"
33   },
34   "account": {
35     "status": "CURRENT",
36     "balance": 1
37   }
38 }

Resolves a Patient by either id or externalId

Authentication

X-API-Keystring

API Key authentication via header

Path parameters

idstringRequired

Response

This endpoint returns an object.

idstring

createdAtdatetime

coveragelist of objects

firstNamestring

lastNamestring

dateOfBirthdatetime

emailstring

patientTokenstring

externalIdstring

phonestring

addressobject

metadataobject

Customizable object of string to string key-value data

accountobject