Developer & Integration Guide

Welkin Health REST API documentation — authenticate, manage patients, send communications, and integrate with the Welkin platform.

Welcome to the Welkin Health API documentation. This guide covers everything you need to build integrations with the Welkin platform — from authentication and patient management to assessments, communications, and data exports.

Base URL

All API requests use the following base URL pattern:

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

Variable	Description
tenantName	Your organization's unique tenant identifier
instanceName	The target environment: live, sandbox, or a named staging instance

Authentication

All API requests require a Bearer token. Tokens are obtained by calling the Authentication endpoint using your API client credentials (key + secret). Tokens expire after 1 hour and should be cached to avoid rate limiting.

Authorization: Bearer <access_token>

Rate limit: Requesting a token more than 100 times per 5 minutes will result in a 5-minute block.

API Clients

API access is granted via an API Client — an auto-generated key/secret pair created in the Welkin Admin panel. Each client can be scoped with specific Security Policies to limit access to only the resources your integration needs.

Key Concepts

Concept	Description
Tenant	Your organization's dedicated space in Welkin (also called Organization)
Instance	An isolated database within a Tenant — typically live, sandbox, or a staging environment
API Client	A key/secret pair used to authenticate API requests
Security Policy	Rules that define what resources an API client can read or write
Designer	Welkin's codeless editor for configuring care programs, forms, and workflows

Resource Overview

Category	Description
Authentication	Obtain Bearer tokens
Patients	Create, search, and manage patient records
CDT Formation	Read Custom Data Type schema definitions
Custom Data Types (CDT)	CRUD operations on CDT record instances
Profile Formation	Read Profile Data Type schema definitions
Profile Records	CRUD operations on patient profile data
Contacts	Manage patient contacts
Encounters	Create and manage clinical encounters
Users	Manage care team users and territories
Assessment Formation	Read assessment schema definitions
Assessment Records	Create and manage assessment responses
Calls	Access voice call records and recordings
SMS	Access SMS message records
Email	Access email records and drafts
Chat / History	Send and retrieve in-app chat messages
Care Plan	Read patient care plans and goals
Calendar	Manage calendar events and schedules
Programs	Read program definitions
Task Management	Create and manage care team tasks
Patient Programs	Enroll patients and manage program phases
Dictionaries	Access dictionary formation and records
Audit	Retrieve data audit and webhook audit logs
Export	Bulk export records across all resource types
Document Types	Read document type schema definitions
Documents	Manage document summary and document records
Unrecognized Calls	Access inbound calls with no matched patient
Unrecognized SMS	Access inbound SMS with no matched patient
Unrecognized Emails	Access inbound emails with no matched patient
Payments & Subscriptions	Manage payment methods and subscriptions
Invoices	Retrieve invoice records
Communication API	Create communication IDs for SMS delivery
Messaging Templates	Resolve dynamic message templates

Postman Collection

All endpoints are available in the official Welkin Public Postman Collection.

---

For questions or integration support, contact the Welkin Health platform team.