workspaces

Create a workspace

Creates a new workspace (veterinary clinic) from a name and country code, and makes the caller its superadmin. Before responding it also records the caller's acceptance of Vetnio's Terms of Service, Privacy Policy and Data Processing Agreement, creates the workspace's default note templates and a billing customer, and may link the clinic to an organization that matches the caller's email domain or lists the clinic on its roster. Failures in those follow-up steps are logged and do not fail the request. The free trial does not start here; it starts with the workspace's first consultation or first VetsGPT conversation. Not idempotent: every successful call creates another workspace. A user may normally create only one workspace (accounts enabled for multi-clinic administration can create up to 200); beyond that the request fails with a generic 500 error. Accepts a session or a personal API key.

post/workspaces

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces
  • Auth
    HTTP bearer

Request body

namestring required

Display name of the clinic, shown in the workspace switcher, on invoices and on PDF letterheads. Not checked for uniqueness or length; an empty string is accepted.

countryCodestring required

Two-letter ISO 3166-1 alpha-2 country code of the clinic, for example se, de or us (matched case-insensitively). It sets regional defaults such as the audio retention policy (12 months for Germany, Austria and Switzerland) and becomes the billing address country. Stored as sent and not validated, so send a real code.

Example request

{
  "name": "Riverside Animal Clinic",
  "countryCode": "se"
}

Response

Workspace created. Use the returned id as workspaceId in subsequent workspace-scoped requests.

idstring required

Identifier of the newly created workspace. Use it as workspaceId in subsequent workspace-scoped calls, for example to create consultations.

Example response

{
  "id": "furunculotic-loud-chihuahua"
}

Changes

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