# Blend Documentation

## Docs

- [Generate token](https://docs.byblend.com/api-reference/authentication/generate-token.md): Login to generate Blend API access tokens. Returns a JWT access token and refresh token. The access token expires in 60 minutes, and the refresh token expires in 7 days.
- [Refresh access token](https://docs.byblend.com/api-reference/authentication/refresh-access-token.md): Refresh the access token using the refresh token. Note that this endpoint requires the refresh token (not access token) be sent in the Authorization header. Returns a new JWT access token.
- [Verify access token](https://docs.byblend.com/api-reference/authentication/verify-access-token.md): Verify the access token. Returns the user details.
- [Single request creation of a prescription and order (and patient/prescriber)](https://docs.byblend.com/api-reference/composite-creation/single-request-creation-of-a-prescription-and-order-and-patientprescriber.md): The composite request is a convenience function that allows you to create an electronic prescription and order in a single request, and optionally also create a patient and/or prescriber. The request body can contain the following objects: `patient`, `prescriber`, `electronic_prescription`, `order`.…
- [Create a new electronic prescription](https://docs.byblend.com/api-reference/electronic-prescriptions/create-a-new-electronic-prescription.md): Deliver an electronic prescription to Blend either in SCRIPT XML or JSON.
- [Get electronic prescription](https://docs.byblend.com/api-reference/electronic-prescriptions/get-electronic-prescription.md): Retrieve an electronic prescription by ID. Electronic prescriptions may contain multiple medications.
- [Get quantity units](https://docs.byblend.com/api-reference/electronic-prescriptions/get-quantity-units.md): Retrieve the quantity units of measure for use in submitting electronic prescriptions.
- [Create a new webhook subscription](https://docs.byblend.com/api-reference/notifications/create-a-new-webhook-subscription.md): Create a new webhook subscription for the current user. Your endpoint must be a valid SSL endpoint that accepts POST requests; returns a 2xx status code within 10 seconds; handles retries with exponential backoff. You may send a sample of any webhook to your endpoint using the `/notification/sample`…
- [Deactivate email subscriptions](https://docs.byblend.com/api-reference/notifications/deactivate-email-subscriptions.md): Deactivate all email subscriptions for the current user.
- [Delete a webhook subscription](https://docs.byblend.com/api-reference/notifications/delete-a-webhook-subscription.md): Delete a webhook subscription by its unique ID.
- [DEP: Create a new subscription](https://docs.byblend.com/api-reference/notifications/dep:-create-a-new-subscription.md): Create a new subscription for notification events. This endpoint is deprecated. Please use the specific endpoints instead for webhooks or email.
- [DEP: Deactivate a subscription](https://docs.byblend.com/api-reference/notifications/dep:-deactivate-a-subscription.md): Deactivate a subscription by its unique ID. This endpoint is deprecated. Please use the specific endpoints instead for webhooks or email.
- [DEP: Get subscriptions](https://docs.byblend.com/api-reference/notifications/dep:-get-subscriptions.md): Retrieve current endpoints and their subscriptions. This endpoint is deprecated. Please use the specific endpoints instead for webhooks or email.
- [Generate a webhook secret](https://docs.byblend.com/api-reference/notifications/generate-a-webhook-secret.md): Generates an authentication secret for webhook endpoints. This secret will be sent as the `Authorization: Bearer {secret}` header in all webhook deliveries, allowing you to verify webhook events as originating from Blend.
- [Get a webhook subscription](https://docs.byblend.com/api-reference/notifications/get-a-webhook-subscription.md): Get a webhook subscription by its unique ID.
- [Get email subscriptions](https://docs.byblend.com/api-reference/notifications/get-email-subscriptions.md): Get email subscriptions for the current user.
- [Get notification event types](https://docs.byblend.com/api-reference/notifications/get-notification-event-types.md): Lists available notification events and their descriptions. "All" is a special event that will trigger receipt for all events.
- [Get webhook subscriptions](https://docs.byblend.com/api-reference/notifications/get-webhook-subscriptions.md): Get webhook subscriptions for the current user.
- [Preview a sample webhook payload](https://docs.byblend.com/api-reference/notifications/preview-a-sample-webhook-payload.md): Get a sample webhook payload for a given event code. Data in this example is illustrative only.
- [Send a sample webhook](https://docs.byblend.com/api-reference/notifications/send-a-sample-webhook.md): Send a sample webhook for testing integrations. This will include the webhook secret in the `Authorization` header if a secret has been set. Data in this example is illustrative only.
- [Update email subscriptions](https://docs.byblend.com/api-reference/notifications/update-email-subscriptions.md): Update email subscriptions for the current user. Email subscriptions will be delivered to the email specified in the user profile.
- [Update webhook subscriptions](https://docs.byblend.com/api-reference/notifications/update-webhook-subscriptions.md): Update a webhook subscription.
- [Cancel an order](https://docs.byblend.com/api-reference/orders/cancel-an-order.md): Cancel an order. Only orders in `received`, `paused`, or `exception` status can be cancelled.
- [Create a custom compounding reason](https://docs.byblend.com/api-reference/orders/create-a-custom-compounding-reason.md): Add a new compounding reason to the Blend inventory.
- [Create an order](https://docs.byblend.com/api-reference/orders/create-an-order.md): Create a new order.
- [Get an order's details](https://docs.byblend.com/api-reference/orders/get-an-orders-details.md): Retrieve details for a specific order by its unique ID.
- [Get an order's status history](https://docs.byblend.com/api-reference/orders/get-an-orders-status-history.md): Retrieve the status history for an order.
- [Get compounding reasons](https://docs.byblend.com/api-reference/orders/get-compounding-reasons.md): Retrieve all compounding reasons.
- [Get order statuses](https://docs.byblend.com/api-reference/orders/get-order-statuses.md): Retrieve all available order status codes and names.
- [Get orders](https://docs.byblend.com/api-reference/orders/get-orders.md): Retrieve all orders. This endpoint returns paginated responses.
- [Get shipping options](https://docs.byblend.com/api-reference/orders/get-shipping-options.md): Retrieve all available shipping carriers and service levels, to be used in an order's `shipping` object.
- [Pause an order](https://docs.byblend.com/api-reference/orders/pause-an-order.md): Pause an order. Only orders in `received` or `exception` status can be paused.
- [Prioritize an order](https://docs.byblend.com/api-reference/orders/prioritize-an-order.md): Request an order be prioritized in the queue. Blend will attempt to expedite filling of priority orders if they have not already been filled.
- [Replace an order](https://docs.byblend.com/api-reference/orders/replace-an-order.md): Request a replacement for an order.
- [Unpause an order](https://docs.byblend.com/api-reference/orders/unpause-an-order.md): Unpause an order. Only orders in `paused` status can be unpaused.
- [Update a custom compounding reason](https://docs.byblend.com/api-reference/orders/update-a-custom-compounding-reason.md): Update the details for a specific compounding reason by its unique ID.
- [Update an order](https://docs.byblend.com/api-reference/orders/update-an-order.md): Update an order. Only address, external ID, (and, if supported in your account) custom shipping or shipping service level preferences can be updated. Shipping details can only be updated if in certain statuses. (Orders that are `verified` are already in the shipping process, and those `shipped` or `…
- [Add freeform risk factor text](https://docs.byblend.com/api-reference/patients/add-freeform-risk-factor-text.md): Attach unprocessed raw text risk factors to a patient. Text will be processed and parsed asynchronously.
- [Create a patient](https://docs.byblend.com/api-reference/patients/create-a-patient.md): Create a new patient.
- [Deactivate a risk factor](https://docs.byblend.com/api-reference/patients/deactivate-a-risk-factor.md): Deactivate a risk factor match for a patient.
- [Get a patient's details](https://docs.byblend.com/api-reference/patients/get-a-patients-details.md): Retrieve details for a specific patient by their unique ID.
- [Get a patient's orders](https://docs.byblend.com/api-reference/patients/get-a-patients-orders.md): Retrieve all orders for a specific patient.
- [Get a patient's risk factors](https://docs.byblend.com/api-reference/patients/get-a-patients-risk-factors.md): Retrieve all risk factors, or risk factors of a specific type, for a patient.
- [Get guardian relationship types](https://docs.byblend.com/api-reference/patients/get-guardian-relationship-types.md): Retrieve a list of all available guardian relationship types.
- [Get patients](https://docs.byblend.com/api-reference/patients/get-patients.md): Retrieve all patients. This endpoint returns paginated responses.
- [Update a patient's details](https://docs.byblend.com/api-reference/patients/update-a-patients-details.md): Update the details for a specific patient by their unique ID. Only updated fields need to be sent.
- [Create a license/qualification](https://docs.byblend.com/api-reference/prescribers/create-a-licensequalification.md): Create a qualification or license for a prescriber.
- [Create a new prescriber](https://docs.byblend.com/api-reference/prescribers/create-a-new-prescriber.md): Create a new prescriber. If you attempt to create a preexisting prescriber (as determined by NPI), the existing prescriber will be returned. If the prescriber already exists elsewhere in Blend (as determined by NPI), the existing prescriber will be associated with your customer.
- [Create a supervisorial relationship](https://docs.byblend.com/api-reference/prescribers/create-a-supervisorial-relationship.md): Create a supervisorial relationship for a specific prescriber in a specific state. Supervisors must have a valid qualification in any state to supervise.
- [Deactivate a license/qualification](https://docs.byblend.com/api-reference/prescribers/deactivate-a-licensequalification.md): Deactivate a license/qualification for a prescriber. This does not delete the qualification, but rather sets it to inactive.
- [Get a prescriber's details](https://docs.byblend.com/api-reference/prescribers/get-a-prescribers-details.md): Retrieve details for a specific prescriber.
- [Get a prescriber's supervisees](https://docs.byblend.com/api-reference/prescribers/get-a-prescribers-supervisees.md): Retrieve all supervisees for a specific prescriber.
- [Get a prescriber's supervisors](https://docs.byblend.com/api-reference/prescribers/get-a-prescribers-supervisors.md): Retrieve all supervisors for a specific prescriber.
- [Get all available credentials](https://docs.byblend.com/api-reference/prescribers/get-all-available-credentials.md): Retrieve a list of all available credentials.
- [Get all available prescribers](https://docs.byblend.com/api-reference/prescribers/get-all-available-prescribers.md): Retrieve a list of all available prescribers.
- [Remove a supervisorial relationship](https://docs.byblend.com/api-reference/prescribers/remove-a-supervisorial-relationship.md): Delete a supervisorial relationship for a specific prescriber in a specific state.
- [Update a license/qualification](https://docs.byblend.com/api-reference/prescribers/update-a-licensequalification.md): Update a license/qualification for a prescriber.
- [Update a prescriber's details](https://docs.byblend.com/api-reference/prescribers/update-a-prescribers-details.md): Update the details for a specific prescriber. To update licenses or qualifications, use the dedicated endpoints.
- [Get non-prescription products](https://docs.byblend.com/api-reference/products-and-materials/get-non-prescription-products.md): Retrieve all non-prescription products. This endpoint returns paginated responses.
- [Get order materials](https://docs.byblend.com/api-reference/products-and-materials/get-order-materials.md): Retrieve all order materials. This endpoint returns paginated responses.
- [Get prescription products](https://docs.byblend.com/api-reference/products-and-materials/get-prescription-products.md): Retrieve all prescription products. This endpoint returns paginated responses.
- [Get products](https://docs.byblend.com/api-reference/products-and-materials/get-products.md): Retrieve all products and materials available for ordering, in separate object arrays.
- [Update a prescription product](https://docs.byblend.com/api-reference/products-and-materials/update-a-prescription-product.md): Update (some) details for a product by its unique ID. Only updated fields need to be sent.
- [Update non-prescription product](https://docs.byblend.com/api-reference/products-and-materials/update-non-prescription-product.md): Update (some) details for a non-prescription product by its unique ID. Only updated fields need to be sent.
- [Update order materials](https://docs.byblend.com/api-reference/products-and-materials/update-order-materials.md): Update (some) details of an order material item by unique ID. Only updated fields need to be sent.
- [Daily report](https://docs.byblend.com/api-reference/reports/daily-report.md): Retrieve daily counts of new patients, prescriptions and orders. Cancelled prescriptions and orders are excluded from the counts.
- [Orders report](https://docs.byblend.com/api-reference/reports/orders-report.md): Retrieve a report of orders by date range and status.
- [Search all](https://docs.byblend.com/api-reference/search/search-all.md): Search across orders, patients, prescribers, products and tasks.
- [Search orders](https://docs.byblend.com/api-reference/search/search-orders.md): Search orders by order number, ID, patient fields, or a substring.
- [Search patients](https://docs.byblend.com/api-reference/search/search-patients.md): Search patients by ID, name, email, phone, date of birth (MM/DD/YYYY or YYYYMMDD or YYYY-MM-DD), or a substring of the above.
- [Search prescribers](https://docs.byblend.com/api-reference/search/search-prescribers.md): Search prescribers by ID, name, email, phone, or a substring.
- [Search products](https://docs.byblend.com/api-reference/search/search-products.md): Search products by name, SKU, or a substring.
- [Search tasks](https://docs.byblend.com/api-reference/search/search-tasks.md): Search tasks by name, description, or a substring.
- [Changelog](https://docs.byblend.com/changelog.md): Product updates, API changes, and announcements.
- [Licensing](https://docs.byblend.com/licensing.md): Blend is licensed in all fifty states and the District of Columbia
- [Building by Blend](https://docs.byblend.com/overview.md): Welcome to the Blend API documentation
- [Privacy Policy](https://docs.byblend.com/privacy.md): Blend Innovations, Inc. – Privacy Policy
- [Security](https://docs.byblend.com/security.md): Blend's approach to data and system security
- [Terms of Service](https://docs.byblend.com/terms.md): Blend Innovations, Inc. – Terms of Service

## OpenAPI Specs

- [openapi](https://docs.byblend.com/openapi.yml)
- [openapi-public](https://docs.byblend.com/openapi-public.yml)
- [apispec_1](https://docs.byblend.com/apispec_1.json)