> For the complete documentation index, see [llms.txt](https://docs.welkinhealth.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.welkinhealth.com/api-reference/overview.md). # Overview Welcome to the Welkin Health API documentation. This reference covers everything you need to build integrations with the Welkin platform — from authentication and patient management to assessments, communications, and data exports. ### 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. See [`Authentication`](/api-reference/authentication.md) for how to exchange your client key/secret for a Bearer token. ### Key Concepts * `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 ### Base URL & Environments Every request is scoped to your `tenantName` (organization) and `instanceName` (environment: `live`, `sandbox`, or a named staging instance). The production host is `https://api.live.welkincloud.io`; sandbox and staging instances use the equivalent host for that environment. ### Resource Overview * [`Patient`](/api-reference/patient.md) — create, search, and manage patient records * [`Custom Data Types (CDT) Formation`](/api-reference/custom-data-types-cdt-formation.md) — read Custom Data Type schema definitions * [`CDT Record`](/api-reference/cdt-record.md) — CRUD operations on CDT record instances * [`Profile Data Types (PDT) Formation`](/api-reference/profile-data-types-pdt-formation.md) — read Profile Data Type schema definitions * [`PDT Record`](/api-reference/pdt-record.md) — CRUD operations on patient profile data * [`Contact`](/api-reference/contact.md) — manage patient contacts * [`Encounters`](/api-reference/encounters.md) — create and manage clinical encounters * [`User`](/api-reference/user.md) — manage care team users and territories * [`Assessment Formation`](/api-reference/assessment-formation.md) — read assessment schema definitions * [`Assessment Record`](/api-reference/assessment-record.md) — create and manage assessment responses * [`Calls`](/api-reference/calls.md) — access voice call records and recordings * [`Sms`](/api-reference/sms.md) — access SMS message records * [`Email`](/api-reference/email.md) — access email records and drafts * [`Chat`](/api-reference/chat.md) — send and retrieve in-app chat messages * [`Care Plan`](/api-reference/care-plan.md) — read patient care plans and goals * [`Calendar API`](/api-reference/calendar-api.md) — manage calendar events and schedules * [`Program`](/api-reference/program.md) — read program definitions * [`Task Management`](/api-reference/task-management.md) — create and manage care team tasks * [`Patient Program`](/api-reference/patient-program.md) — enroll patients and manage program phases * [`Dictionaries`](/api-reference/dictionaries.md) — access dictionary formation and records * [`Audit`](/api-reference/audit.md) — retrieve audit logs of system and user activity * [`Export`](/api-reference/export.md) — bulk export data across all patients (CDT records, assessments, calls, and more) * [`Document Types`](/api-reference/document-types-formation.md) — read document type definitions * [`Documents`](/api-reference/documents.md) — upload and manage patient documents * [`Unrecognized Calls`](/api-reference/unrecognized-calls.md) — manage inbound calls from unrecognized numbers * [`Unrecognized SMS`](/api-reference/unrecognized-sms.md) — manage inbound SMS from unrecognized numbers * [`Unrecognized Emails`](/api-reference/unrecognized-emails.md) — manage inbound email from unrecognized senders * [`Payments & Subscriptions`](/api-reference/payment-and-subscription.md) — manage patient payments and subscription plans * [`Invoices`](/api-reference/invoices.md) — manage patient invoices * [`Communication API`](/api-reference/communication-api.md) — send outbound communications across channels * [`Messaging Templates`](/api-reference/messaging-templates.md) — manage reusable message templates * [`Fax`](/api-reference/fax.md) — send and receive fax documents --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.welkinhealth.com/api-reference/overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.