Organizations API

Available Endpoints

List Organizations

Retrieve a paginated list of organizations

Create Organization

Create a new organization

Get Organization

Retrieve a specific organization by ID

Update Organization

Update an existing organization

Delete Organization

Soft delete an organization (mark as inactive)

Update Organization Metadata

Update organization metadata with custom fields

Data Structures

Organization Object

Field	Type	Description
id	string	Unique identifier for the organization
name	string	Organization name
email	string	Organization email address
address	string	Street address
city	string	City
stateProvince	string	State or province
postalCode	string	Postal code or ZIP code
country	string	Country
phoneNumber	string	Contact phone number
tenantId	string	Tenant ID that the organization belongs to
timezone	string	Timezone (e.g., “America/New_York”)
createdAt	string	Creation timestamp (ISO 8601 format)
createdBy	string	ID of the user who created the organization

Metadata Object

Organization metadata allows you to sync external clinic info to AlloMia organization. The metadata structure is validated against a schema that you define.

Example metadata object:

{
  "specialties": ["cardiology", "neurology"],
  "emrSystem": "Epic",
  "operatingHours": {
    "monday": "9:00-17:00",
    "tuesday": "9:00-17:00",
    "wednesday": "9:00-17:00",
    "thursday": "9:00-17:00",
    "friday": "9:00-17:00"
  },
  "services": {
    "telehealth": true,
    "inPersonVisits": true,
    "emergencyCare": false
  }
}

API Documentation

Organizations (Tenant Only)

Calls

Outbound Calls

Overview

Available Endpoints

List Organizations

Create Organization

Get Organization

Update Organization

Delete Organization

Update Organization Metadata

Authentication

Data Structures

Organization Object

Metadata Object

​Overview

​Available Endpoints

List Organizations

Create Organization

Get Organization

Update Organization

Delete Organization

Update Organization Metadata

​Authentication

​Data Structures

​Organization Object

​Metadata Object

Overview

Available Endpoints

Authentication

Data Structures

Organization Object

Metadata Object