---
title: "Documentation - HyperCRM"
description: "HyperCRM documentation: a getting-started walkthrough, task guides for scheduling, records, forms, files, billing and staff, plus the REST API reference."
canonical: "https://hypercrm.app/docs"
lang: "en"
updated: "2026-07-25"
---

_Documentation_

# Set it up, then get on with the day

Practical documentation for running a practice on HyperCRM: a walkthrough for your first week, task-shaped guides for the work you repeat daily, and a reference for the REST API and MCP server underneath it.

[Get started](/docs/getting-started) · [Browse the guides](/docs/guides)

## Three ways in

If you are setting up a practice for the first time, start with [getting started](/docs/getting-started): create the practice, invite your staff, set your working hours, and get a service catalogue in place. It is written to be followed once, in order.

If you are already running and want to do one specific thing well, go to the [guides](/docs/guides). They are organised by task rather than by screen — booking and rescheduling, patient records and notes, intake and consent forms, files and imaging, billing, and staff and permissions.

If you are building against HyperCRM, the [API reference](/docs/api) covers authentication, patients, appointments and the error envelope, and [MCP & AI agents](/developers/mcp) covers what an AI agent can do today.

## If a guide does not cover it

Coverage is deliberately task-first rather than exhaustive: the work you do every week is documented, and the rarer corners are not all written down.

So if you are trying to do something and the guides do not say how, [ask us directly](/contact) rather than reverse-engineering it. Questions from real practices are how the gaps get found and closed.

## Start here

### [Getting started](/docs/getting-started)

Your first week: create the practice, invite staff, set working hours, and build a service catalogue.

### [Guides](/docs/guides)

Task-shaped instructions for the daily work — appointments, records, forms, files, billing and staff.

### [API reference](/docs/api)

Authentication, patients, appointments and errors, for building against HyperCRM directly.

### [MCP server](/docs/mcp)

Connect an MCP client — the endpoint, OAuth 2.1 authorisation, and all 57 tools with their permissions.

## Common questions

### How is patient data protected?

Patient records are encrypted in transit and at rest, files are stored privately and served through short-lived signed links, and every change is written to an audit log. Staff accounts sign in with passkeys rather than shared passwords.

### Can I export my data?

Yes. Every list in HyperCRM exports to CSV from the app, and your files can be downloaded at any time. Your practice data belongs to you, and there is no export fee or waiting period — on either plan, during the trial, and after you cancel.

### How do I find the right page quickly?

Start from the hub above or the guides index — the guides are organised by the task you are trying to do rather than by the screen you are looking at, which is usually the faster way in. If you cannot find it in a minute, ask us and we will point you at it.

### What if a guide does not cover what I need?

Ask us directly rather than guessing from the interface. Coverage is task-first rather than exhaustive, so rarer corners genuinely are not all written down yet, and questions from real practices are the main way those gaps get found and closed.