How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Xrhealth

XRHealth Platform API

First-party REST API for XRHealth applications and approved integrations, published as OpenAPI 3.1.0 at https://api.xr.health/v1/openapi.json. The document currently describes the platform authentication module: passwordless (one-time email code) patient login for server-side applications holding an X-XRHealth-Application-Token, a PKCE public-client variant for native and browser clients, refresh-token rotation and revocation, a /me subject endpoint, and a JWKS endpoint publishing the public signing keys for XRHealth patient access tokens.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 12 operations across 12 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.xr.health/v1.

12 operations 12 paths 10 schemas 4 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.xr.health/v1
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

XRHealth Platform API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-XRHealth-Application-Token (applicationToken). It accepts HTTP bearer tokens (JWT) (patientBearer).

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 4 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 12
GET
/
Get API metadata
getApiMetadata → 200
GET
/openapi.json
Get the OpenAPI document
getOpenApiDocument → 200
POST
/auth/passwordless/start
Send a one-time patient login code
startPatientPasswordlessLogin body → 202400401403429503
POST
/auth/passwordless/verify
Exchange a one-time code for XRHealth tokens
verifyPatientPasswordlessLogin body → 200401403503
POST
/auth/public/passwordless/start
Start passwordless login for a registered public client
startPublicPatientPasswordlessLogin body → 202400401403429503
POST
/auth/public/passwordless/verify
Exchange a passwordless code for a short-lived PKCE authorization code
verifyPublicPatientPasswordlessLogin body → 200401403503
POST
/auth/public/token
Exchange a PKCE authorization code or rotate a public-client refresh token
exchangePublicPatientToken body → 200401403503
POST
/auth/public/token/revoke
Revoke a public-client refresh token
revokePublicPatientToken body → 200400401503
POST
/auth/token/refresh
Rotate a patient refresh token
refreshPatientToken body → 200401503
POST
/auth/token/revoke
Revoke a patient refresh token
revokePatientToken body → 200400401503
GET
/me
Get the current public patient subject
getCurrentPatient → 200401403503
GET
/.well-known/jwks.json
Get the public signing keys for XRHealth patient access tokens
getPatientApiJwks → 200503

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are TokenResponse (7 properties), PublicTokenRequest (5 properties), PublicPasswordlessVerifyRequest (4 properties), PublicPasswordlessStartRequest (4 properties). Each schema is shown below with its type and property counts.

PasswordlessStartRequest
object
1 property 1 required
PasswordlessVerifyRequest
object
3 properties 3 required
PublicPasswordlessStartRequest
object
4 properties 4 required
PublicPasswordlessVerifyRequest
object
4 properties 4 required
PublicTokenRequest
object
5 properties 2 required
PublicTokenRevokeRequest
object
2 properties 2 required
AuthorizationCodeResponse
object
2 properties 2 required
RefreshTokenRequest
object
1 property 1 required
TokenResponse
object
7 properties 7 required
MeResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xrhealth-platform-openapi.yml Raw ↑
#Health#Digital Health#Telehealth#Patient Authentication#Extended Reality
← Back to X APIs
API Details
ID
xrhealth:xrhealth-platform-api
Base URL
https://api.xr.health/v1
Docs
https://developer.xr.health/
Provider
Xrhealth
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=xrhealth-xrhealth-platform-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/xrhealth-xrhealth-platform-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of XRHealth Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.