Getting Started

Welcome to the IntakeDesk documentation. This guide will walk you through the basics of setting up and using IntakeDesk to streamline your referral intake process.

Installation

To get started, you will need to install our client libraries and configure your environment. We provide packages for popular EMR systems and a REST API for custom integrations.

Example Code

Here is an example of how to install the necessary packages.

npm install @intakedesk/client

Configuration

To generate an API Key, use the POST /api/api-keys endpoint (authenticated via your Dashboard session) or contact support to enable the API Keys UI in your dashboard.

Authentication

The API supports two methods of authentication:

Bearer Token: Standard Firebase ID Token. Used by frontend clients acting on behalf of a user.
```
Authorization: Bearer <ID_TOKEN>
```
API Key: Secret key for server-side integrations. Grants full access to the organization's resources.
```
x-api-key: sk_...
```

API Reference

The IntakeDesk API provides endpoints for managing referrals, patients, and documents. All endpoints require authentication.

Referrals

Endpoint	Method	Description
/api/referrals?orgId=...	GET	List referrals for an organization.
/api/referrals	POST	Create a new referral. Returns signed URL for file upload.

Patients

Endpoint	Method	Description
/api/patients?orgId=...&q=...	GET	Search patients by name or ID.
/api/patients	POST	Create or update a patient record.

Documents

Endpoint	Method	Description
/api/referral-documents?orgId=...	GET	List documents for a referral or patient.
/api/referral-documents	POST	Attach a document to a referral/patient.

Management

Endpoint	Method	Description
/api/api-keys	POST	Generate a new API Key (requires User Token).
/api/api-keys	GET	List active API Keys.
/api/api-keys	DELETE	Revoke an API Key.