List Patients

GET

/api/patients

GET

/api/patients

$ curl https://app.usebridge.com/api/patients \
>      -H "X-API-Key: <apiKey>"

200Retrieved

1 {
2   "items": [
3     {
4       "id": "id",
5       "createdAt": "2024-01-15T09:30:00Z",
6       "coverage": [
7         {
8           "id": "id",
9           "rank": 1,
10           "policyId": "policyId"
11         },
12         {
13           "id": "id",
14           "rank": 1,
15           "policyId": "policyId"
16         }
17       ],
18       "firstName": "firstName",
19       "lastName": "lastName",
20       "dateOfBirth": "2024-01-15T09:30:00Z",
21       "email": "email",
22       "patientToken": "patientToken",
23       "externalId": "externalId",
24       "phone": "phone",
25       "address": {
26         "state": "AL",
27         "line1": "line1",
28         "line2": "line2",
29         "city": "city",
30         "postalCode": "postalCode",
31         "country": "US"
32       },
33       "metadata": {
34         "exampleKey": "exampleKey"
35       },
36       "account": {
37         "status": "CURRENT",
38         "balance": 1
39       }
40     },
41     {
42       "id": "id",
43       "createdAt": "2024-01-15T09:30:00Z",
44       "coverage": [
45         {
46           "id": "id",
47           "rank": 1,
48           "policyId": "policyId"
49         },
50         {
51           "id": "id",
52           "rank": 1,
53           "policyId": "policyId"
54         }
55       ],
56       "firstName": "firstName",
57       "lastName": "lastName",
58       "dateOfBirth": "2024-01-15T09:30:00Z",
59       "email": "email",
60       "patientToken": "patientToken",
61       "externalId": "externalId",
62       "phone": "phone",
63       "address": {
64         "state": "AL",
65         "line1": "line1",
66         "line2": "line2",
67         "city": "city",
68         "postalCode": "postalCode",
69         "country": "US"
70       },
71       "metadata": {
72         "exampleKey": "exampleKey"
73       },
74       "account": {
75         "status": "CURRENT",
76         "balance": 1
77       }
78     }
79   ],
80   "count": 1
81 }

Authentication

X-API-Keystring

API Key authentication via header

Query parameters

pageintegerOptional

limitintegerOptional

Response

This endpoint returns an object.

itemslist of objects

List results

countintegerOptional

Total count (if available)