Get an organization with its clinics, people and templates
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.
Request
- Base URLhttps://vetnio.com/api/v2
- URLhttps://vetnio.com/api/v2/organizations/{organizationId}
- AuthHTTP bearer
Path parameters
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
The organization overview.
Example response
{
"organization": {
"id": "3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e42",
"name": "Riverside Veterinary Group"
},
"workspaces": [
{
"id": "furunculotic-loud-chihuahua",
"name": "Riverside Animal Clinic",
"city": "Uppsala",
"countryCode": "se",
"createdAt": "2025-11-03T09:12:44.000Z"
}
],
"members": [
{
"userId": "0f8fad5b-d9cb-469f-a165-70867728950e",
"name": "Dr. Sam Lee",
"email": "sam.lee@riverside-vets.example",
"workspaces": [
{
"workspaceId": "furunculotic-loud-chihuahua",
"role": "member"
}
]
}
],
"templates": [
{
"id": "2a9b8c7d-6e5f-4a3b-9c1d-0e2f4a6b8c0d",
"name": "Group clinical note",
"type": "clinical_note",
"createdBy": "0f8fad5b-d9cb-469f-a165-70867728950e",
"createdAt": "2026-02-10T13:00:00.000Z"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.