Who can call these endpoints
Only a partner key works here, and its creator must be the partner account owner or a Tenant Admin. A clinic key gets401 (Invalid authorization, or Tenant ID is required on metadata) or 403 (Insufficient permissions). See Authentication.
List, Get, Update and Delete only see the active clinics in your partner account. Any other clinic returns 404, the same as a clinic that doesn’t exist.
Endpoints
List organizations
GET /api/organization: page through your active clinics.Create organization
POST /api/organization: add a clinic to your partner account.Get organization
GET /api/organization/{id}: read one clinic.Update organization
PUT /api/organization/{id}: change a clinic’s details.Delete organization
DELETE /api/organization/{id}: deactivate a clinic.Update organization metadata
PUT /api/organization/{id}/metadata: replace a clinic’s metadata.The organization object
The organization endpoints return these fields. Not every endpoint returns all of them; each endpoint page lists its own.
Some responses include other fields that aren’t listed here. Don’t build on them; they may change or be removed.
Ownership
When you create a clinic with a partner key, the person who created that key becomes the clinic’s owner and a member of it. That matters later, because some endpoints check the key creator’s role. For example, only a clinic key created by the clinic owner can place outbound calls for that clinic.Metadata
Metadata is a JSON object that carries your system’s information about a clinic into AlloMia. Each update replaces the whole object, is checked against a JSON Schema, and raises the metadata’sversion by 1.
Metadata only exists for a clinic when both of these are true:
- AlloMia has set up an integration, with its JSON Schema, for your partner account. Ask AlloMia to set it up and to share the schema with you.
- The clinic was created with an
externalId, either through Create organization or with the External ID field in the dashboard.
404. To see a clinic’s current metadata in the dashboard, open Organizations in your partner account, then the clinic’s actions menu (⋮), then Metadata. This item only appears for clinics that have metadata.
External ID
externalId is your own identifier for the clinic, up to 255 characters. AlloMia stores it only when your partner account has an integration set up. Otherwise the API accepts it and ignores it. While stored, it must be unique: a second clinic with the same externalId gets 409. You can’t change it with Update organization.