---
title: "Get an organization with its clinics, people and templates"
method: GET
path: "/organizations/{organizationId}"
tags: ["data-export"]
---

# Get an organization with its clinics, people and templates

`GET /organizations/{organizationId}`

## Request

- Base URL: `https://vetnio.com/api/v2`
- URL: `https://vetnio.com/api/v2/organizations/{organizationId}`
- Auth: HTTP bearer

Returns the organization, its clinics, its people (organization members and clinic staff, one row per person) and the names of its organization-level templates. Use it to look up clinic IDs for the usage export's `workspaceIds` and to map user IDs in usage rows to people. With a workspace key, `workspaces` and clinic staff are limited to that clinic, but organization members and organization templates are still listed. Read-only; every call is recorded in the audit log. Requires organization admin rights: an organization or workspace API key, or a personal key or session of an organization admin.

## Path parameters

- `organizationId` string, required: Identifier of the organization (a UUID). With an organization or workspace key, use the `organizationId` returned by `GET /api-key`; any other organization returns 403.

## Response `200`

The organization overview.

- OrganizationExportOverview: The organization with its clinics, people and organization-level templates.
  - `organization` object, required: The organization being exported.
    - `id` string, required: Organization ID (UUID).
    - `name` string, required: Organization display name.
  - `workspaces` object[], required: Clinics in scope, sorted by name. Clinics that are locked or being deleted or merged are left out here, although the usage export still reports them. A workspace key sees only its own clinic.
    - `id` string, required: Workspace (clinic) ID. Use it in the usage export's `workspaceIds` filter.
    - `name` string, required: Clinic name, or the clinic ID when no name has been set.
    - `city` string, nullable, required: City of the clinic's address, or null if not set.
    - `countryCode` string, nullable, required: Two-letter country code of the clinic as stored (case as entered), or null if not set.
    - `createdAt` string, required: When the clinic was created in Vetnio (ISO-8601 UTC).
  - `members` object[], required: Organization members and staff of the clinics in scope, merged to one row per person and sorted by email. Organization members are always included, even for a workspace key.
    - `userId` string, required: User ID (UUID). Matches the `Vet ID` column of the usage export.
    - `name` string, nullable, required: The person's display name, or null if they have not set one.
    - `email` string, required: The person's login email address.
    - `organizationRole` 'member' | 'admin' | 'superadmin', nullable, required: Role in the organization, or `null` for clinic-only staff: - `member` — belongs to the organization without admin rights. - `admin` — organization administrator. - `superadmin` — organization administrator with the highest role. Both `admin` and `superadmin` have organization admin rights in the API.
    - `workspaces` object[], required: The person's direct memberships in the clinics in scope. Empty for organization members who do not belong to any of those clinics.
      - `workspaceId` string, required: ID of a clinic in scope that the person belongs to directly.
      - `role` 'member' | 'admin' | 'superadmin', required: The person's role in this clinic: - `member` — clinician. - `admin` — clinic administrator. - `superadmin` — clinic administrator who can also delete the clinic and manage other superadmins.
  - `templates` object[], required: Organization-level templates shared to its clinics, oldest first. Names and metadata only; download bodies with `GET /organizations/{organizationId}/data-export/templates`.
    - `id` string, required: Organization template ID (UUID).
    - `name` string, required: Template name.
    - `type` 'clinical_note' | 'referral' | 'client_communication', required: What the template produces: - `clinical_note` — the clinical note (medical record entry) for a consultation. - `referral` — a referral letter to another clinic or specialist. - `client_communication` — a message to the pet owner.
    - `createdBy` string, required: User ID (UUID) of the organization admin who created the template.
    - `createdAt` string, required: When the template was created (ISO-8601 UTC).

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

---

[API](https://skmtc.dev/vetnio/apis/vetnio-api.md) - [All operations](https://skmtc.dev/vetnio/apis/vetnio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vetnio/apis/vetnio-api/revisions/d004afd5617d?raw)