> ## Documentation Index > Fetch the complete documentation index at: https://api.vitarelay.com/llms.txt > Use this file to discover all available pages before exploring further. # List prescriptions ## OpenAPI ````yaml /openapi.yaml get /prescriptions openapi: 3.1.0 info: title: VitaRelay API version: 2.0.0 description: | The VitaRelay REST API. **Base URL:** `https://vitarelay.com/api/public/v1` ## Authentication All requests require a Bearer API key: ```text Authorization: Bearer vr_live_xxxxxxxxxxxxxxxx ``` Keys are issued per organization. `vr_live_` keys act on production data. `vr_test_` keys operate a fully-isolated **sandbox** (see below). ## Pagination List endpoints are cursor-based. Pass `limit` (default 50, max 100) and `cursor` (the `next_cursor` from the previous page). When `next_cursor` is `null` there are no further pages. All resource ids are UUIDs. ## Idempotency Write endpoints accept your own external identifiers — `external_patient_id`, `external_intake_id`, `external_order_id`. These act as idempotency keys: replaying a request with the same external id returns the original resource (HTTP `200` instead of `201`) rather than creating a duplicate. ## Rate limiting Write endpoints are rate limited per API key — default **60 requests per minute** (fixed window). Exceeding the limit returns `429 rate_limited` with `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` headers. Read endpoints are not rate limited in v1. ## Sandbox With a `vr_test_` key, writes never create real patients, intakes or orders and never charge a card. They return synthetic ids (`sandbox_pat_…`, `sandbox_int_…`, `sandbox_ord_…`) and include `"sandbox": true` in the response. Sandbox objects advance through a simulated lifecycle that fires real webhook deliveries to your endpoint (`intake.reviewed`, `order.paid` → `order.shipped` → `order.delivered`) with `"sandbox": true` in the payload. In sandbox, reference a patient by `external_patient_id` or by the returned `sandbox_pat_…` id. ## Webhooks Outbound webhooks are configured in the VitaRelay admin UI (there is no webhook management API). Events: `order.paid`, `order.shipped`, `order.delivered`, `order.exception`, `intake.reviewed`. Each delivery is signed with HMAC-SHA256 over the raw body and carries the headers `X-VitaRelay-Signature: sha256=`, `X-VitaRelay-Event`, `X-VitaRelay-Delivery` (event id) and `X-VitaRelay-Timestamp`. Failed deliveries are retried with exponential backoff and dead-lettered after the maximum attempts. contact: name: VitaRelay Support email: info@vitarelay.com servers: - url: https://vitarelay.com/api/public/v1 description: Production security: - bearerAuth: [] tags: - name: Patients description: Patient records scoped to your organization. - name: Intakes description: Intake form submissions. Write access is Vita Clinic only. - name: Orders description: >- Orders and fulfillment status. Two billing modes: `card_on_file` (default) charges the clinic's stored card synchronously, and `patient_checkout` creates the order unpaid and returns a checkout block so the patient can pay on your own page via Authorize.Net Accept.js (see POST /orders/{id}/pay). - name: Products description: Catalog products available to your organization. - name: Prescriptions description: >- Prescriptions written by your organization (read only). Refer patients into the Internal Doctor Network (IDN). You refer; an IDN doctor evaluates and prescribes. Requires IDN activation and rx scopes. - name: Storefront description: >- Build and manage your clinic's patient storefront — settings, curated product listings and bundles. Requires the `shop:read` / `shop:write` scopes. - name: Subscriptions description: >- Patient-shop subscription lifecycle. Requires `subscriptions:read` or `subscriptions:write`. paths: /prescriptions: get: tags: - Prescriptions summary: List prescriptions operationId: listPrescriptions parameters: - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Cursor' - name: status in: query required: false schema: type: string responses: '200': description: A page of prescriptions. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Prescription' next_cursor: type: - string - 'null' format: date-time '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' components: parameters: Limit: name: limit in: query required: false description: Page size. Default 50, maximum 100. schema: type: integer minimum: 1 maximum: 100 default: 50 Cursor: name: cursor in: query required: false description: The `next_cursor` value returned by the previous page. schema: type: string format: date-time schemas: Prescription: type: object properties: id: type: string format: uuid patient_id: type: - string - 'null' format: uuid provider_org_id: type: - string - 'null' format: uuid order_id: type: - string - 'null' format: uuid product_name: type: - string - 'null' dosage: type: - string - 'null' frequency: type: - string - 'null' quantity: type: - integer - 'null' refills_authorized: type: - integer - 'null' status: type: string expires_at: type: - string - 'null' format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time example: id: d5e6f7a8-9b0c-1d2e-3f4a-5b6c7d8e9f0a patient_id: 3f0b1c2a-8f4e-4a9b-9c1d-2e5f7a8b9c0d provider_org_id: c6555c75-1111-2222-3333-444455556666 order_id: c4d5e6f7-8a9b-0c1d-2e3f-4a5b6c7d8e9f product_name: Semaglutide dosage: 0.25 mg weekly frequency: weekly quantity: 1 refills_authorized: 2 status: active expires_at: '2027-08-12T00:00:00Z' created_at: '2026-08-12T14:12:00Z' updated_at: '2026-08-12T14:12:00Z' Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: | One of `invalid_body`, `validation_failed`, `unauthorized`, `insufficient_scope`, `not_vita_clinic`, `patient_not_found`, `product_not_found`, `product_not_allowed`, `duplicate_request`, `rate_limited`, `card_required`, `payment_declined`, `internal_error`, `not_found`. message: type: string example: error: code: validation_failed message: One or more fields are invalid responses: Unauthorized: description: Missing, invalid or revoked API key (`unauthorized`). content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: | The key lacks the required scope (`insufficient_scope`) or its organization is not an active Vita Clinic (`not_vita_clinic`). content: application/json: schema: $ref: '#/components/schemas/Error' InternalError: description: Unexpected server error (`internal_error`). content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer description: | API key issued by VitaRelay. Send as `Authorization: Bearer vr_live_…` (production) or `Authorization: Bearer vr_test_…` (sandbox). ````