Quickstart

Make your first API call in under 5 minutes.

Prerequisites

An API token (see Authentication)
Your organization UUID (org_id)

Step 1: List Patients

Make the request

bash

curl -X GET "https://api.example.com/api/v1/{org_id}/patients?page=1&page_size=5" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Check the response

You'll receive a paginated list of patients:

json

{
  "items": [
    {
      "id": 1,
      "uuid": "a1b2c3d4-...",
      "first_name": "Jane",
      "last_name": "Smith",
      "date_of_birth": "1990-05-15",
      "status": "active"
    }
  ],
  "total": 142,
  "page": 1,
  "page_size": 5,
  "pages": 29
}

Create a patient

bash

curl -X POST "https://api.example.com/api/v1/{org_id}/patients" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "date_of_birth": "1985-03-20"
  }'

Next Steps

Pagination

Learn how to navigate large result sets.

API Reference

Explore all available endpoints.