Introduction
API Principles
Resources
API Reference
Deprecated APIs

List Patient Consents

GET

/api/patients/:id/consent

GET

/api/patients/:id/consent

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

Try it

200Retrieved

1 {
2   "id": "id",
3   "patientId": "patientId",
4   "type": "ASSIGNMENT_OF_BENEFITS",
5   "version": "version",
6   "consentedAt": "2024-01-15T09:30:00Z",
7   "expiresAt": "2024-01-15T09:30:00Z",
8   "status": "ACTIVE"
9 }

Authentication

X-API-Keystring

API Key authentication via header

Path Parameters

idstringRequired

Query Parameters

pageintegerOptional

limitintegerOptional

Response

This endpoint returns an object.

idstring

patientIdstring

typeenum

Allowed values:

versionstring

consentedAtdatetime

expiresAtdatetime

statusenum

Allowed values:

Was this page helpful?

Sandbox Dashboard