For the complete documentation index, see llms.txt. This page is also available as Markdown.

Base URL & Environments

Every Welkin API request is scoped to a specific tenant and instance. Understanding this two-part structure is essential before making your first call.

Base URL Pattern

https://api.welkinhealth.com/{tenantName}/{instanceName}/
Variable
Description

tenantName

Your organization's unique identifier, provided during onboarding (e.g., acme-health)

instanceName

The target environment within your tenant: live, sandbox, or a named staging instance

Example — production request:

GET https://api.welkinhealth.com/acme-health/live/patients

Example — sandbox request:

GET https://api.welkinhealth.com/acme-health/sandbox/patients

Environments

Welkin tenants have multiple isolated environments that share the same configuration (CDTs, programs, roles) but maintain completely separate patient data.

Environment
Purpose

live

Production environment — real patient data, active care delivery

sandbox

Integration testing — safe to create, modify, and delete records without affecting production

Custom (e.g., staging)

Some organizations have additional named environments for UAT or QA

Important: Always test against sandbox before running integrations against live. Data written to live affects real patient records.

Finding Your Tenant Name

Your tenantName is provided by Welkin during onboarding. You can also find it in the URL when logged into the Welkin Care or Admin portal:

HTTPS Required

All API requests must use HTTPS. HTTP requests will be rejected. TLS 1.2 or higher is required.

Request Headers

Every API request requires:

See Authentication for how to obtain a Bearer token.


Last updated

Was this helpful?