List Prescriptions

get

https://patient-api.portals.care/prescriptions

Retrieve patient prescriptions with optional filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieve a list of prescriptions for the patient. Authenticate by providing the patient's JWT in the authorization header. Y

You can also use a variety of optional query parameters to filter the list, such as:

din
customerId

Query Params

maxId

string

Filter prescriptions with an ID less than or equal to this value.

minId

string

Filter prescriptions with an ID greater than or equal to this value.

din

string

Filter prescriptions by a specific Drug Identification Number (DIN).

dins

array of strings

Filter prescriptions by a list of Drug Identification Numbers (DINs).

dins

customerId

string

Filter prescriptions by a unique patient identifier.

includeVoided

boolean

If true, includes voided prescriptions in the results. Defaults to false.

customerName

string

Filter prescriptions by the patient's name (first or last).

prescriberName

string

Filter prescriptions by the prescriber's name.

includeFulfilled

boolean

If true, includes fulfilled prescriptions in the results. Defaults to false.

orderId

string

Filter prescriptions associated with a specific order ID.

Headers

authorization

string

required

A Valid JWT Authentication token.

organization

string

Your unique Organization ID. This header is only required when using a custom portal domain, otherwise it is optional.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200