Get organization
| Method | Path |
|---|---|
GET | /v1/slim/organization/:id |
Authentication · Access policies
Returns one organization (a zone in the Slim dashboard) by id. Use it to show or edit a zone.
Auth: Bearer token. The caller must be a practitioner, an admin, a super admin, or hold the "System Owner" access policy. The access policy must grant Organization:read (admins and super admins skip this check).
Scope: The organization is read with the caller's own token, so you get any organization your Medplum access lets you read. There is no extra project check on this route.
Behaviour
- Read-only.
descriptionis the organization's narrative text with the XHTML<div>wrapper removed. It is absent when the organization has no narrative.parentOrganizationIdis the id fromOrganization.partOf. It is absent for a top-level zone.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/organization/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
-H "Authorization: Bearer ${OVOK_TOKEN}"
| Field | Type | Meaning |
|---|---|---|
id | string | Organization/zone id. |
name | string | Display name. |
parentOrganizationId | string or omitted | Parent zone id when this zone is nested. |
description | string or omitted | Narrative text without the FHIR XHTML wrapper. |
Successful response
200 — Organization retrieved successfully.
Errors
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You are not a practitioner, admin or System Owner, you lack Organization:read, or Medplum refuses you the organization. |
404 | No organization with this id exists. |
422 | id is not a UUID. |