Export an organization's settings and transcription terms

Exports the current stored settings and the current transcription term list of exactly this scope as versioned JSON (schemaVersion 1), with an inventory that lists what is included, what is excluded and how to interpret it. Credentials, billing identifiers and other scopes' private settings are never included. Values are read at request time, so this is neither a change history nor an atomic snapshot. Read-only. Covers the organization's identity, address, custom domains, billing presentation preferences, audio-retention policy and organization term list. Requires admin rights in the organization. Accepts a browser session or a personal API key; organization and workspace API keys (sk_org_…, sk_ws_…) get 403.

get/organizations/{organizationId}/data-export/content

Request

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

Path parameters

organizationIdstring required

Identifier of the organization to export (a UUID). The caller must be an admin of it.

Example:3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e42

Response

Successful response

schemaVersion1 required

Version of the export format. Currently always 1.

exportedAtstring date-time required

When this export was produced (ISO 8601, UTC). Values are read separately, so this is not the time of an atomic snapshot.

scopeIdstring required

ID of the exported user, workspace or organization. Equal to configuration.id.

scope'organization' required

Exported scope. Always organization for this endpoint.

Example response

{
  "schemaVersion": 1,
  "exportedAt": "2026-09-28T08:15:00.000Z",
  "scopeId": "furunculotic-loud-chihuahua",
  "termList": {
    "terms": [
      "Librela",
      "Apoquel",
      "Bravecto"
    ],
    "version": 3,
    "updatedAt": "2026-09-28T08:15:00.000Z",
    "updatedBy": "7d1f0c3e-2a4b-4e8f-9c61-5b2a8d4e7f10"
  },
  "inventory": {
    "included": [
      "Workspace identity, address and allowlisted settings",
      "Current workspace transcription term list"
    ],
    "excluded": [
      "Credentials, API keys, OAuth/session/password material and provider connection secrets"
    ],
    "limitations": [
      "Current stored values only; separate reads do not form an atomic snapshot"
    ]
  },
  "scope": "organization",
  "configuration": {
    "id": "3f6c2a1e-8b4d-4c7a-9e2f-5d1b7a9c0e42",
    "name": "Riverside Veterinary Group",
    "address": {
      "street": "12 Harbour Street",
      "attention": "Accounts Payable",
      "city": "Riverside",
      "stateProvince": "Riverside County",
      "zipCode": "114 51",
      "countryCode": "SE"
    },
    "customDomains": [
      "riverside-vet.example"
    ],
    "audioFileRetentionPeriodInDays": 365,
    "createdAt": "2026-09-28T08:15:00.000Z",
    "updatedAt": "2026-09-28T08:15:00.000Z",
    "preferences": {
      "billingLegalName": "Riverside Veterinary Group AB",
      "billingTaxExempt": "reverse",
      "billingTaxId": "SE556677889901",
      "billingClinicAttentionLine": true,
      "aiTitlesEnabled": true,
      "recordingView": "briefing"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.