Skip to main content

​
Overview

The Organization API provides endpoints for tenants to manage organizations within their account. These endpoints require a tenant-specific API key for authentication.

​
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

​
Authentication

All Organization API endpoints require authentication using a tenant-specific API key in the format: 
Authorization: Bearer YOUR-API-KEY
For more information on authentication, see the Authentication guide.

​
Data Structures

​
Organization Object

FieldTypeDescription
idstringUnique identifier for the organization
namestringOrganization name
emailstringOrganization email address
addressstringStreet address
citystringCity
stateProvincestringState or province
postalCodestringPostal code or ZIP code
countrystringCountry
phoneNumberstringContact phone number
tenantIdstringTenant ID that the organization belongs to
timezonestringTimezone (e.g., “America/New_York”)
createdAtstringCreation timestamp (ISO 8601 format)
createdBystringID 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
  }
}