Overview

The Upvio API is a REST API for managing patients, vitals scans, and health screening workflows. All requests use JSON and authenticate via Bearer token.

Base URL:

https://api.upvio.com/v1/businesses/{businessId}

Replace {businessId} with your Business ID, found on the API Keys page.

API KeysCreate keys and authenticate your requests.

Response FormatUnderstand the data, meta, and error wrappers.

PaginationPage through list results with limit and offset.

Error HandlingHTTP status codes and error response structure.

Request IDsIdentify individual API requests when contacting support.

WebhooksReceive real-time notifications when events happen.

OpenAPI specification

The full v1 API is described by a public OpenAPI 3.1 document. Point your API tooling (Postman, Insomnia, client generators, and similar) at it, or browse the generated API v1 Reference.

https://api.upvio.com/v1/openapi.json