clients

Get client (owner) details

Returns one client (owner) with its contact details. Returns 404 when no client with this id exists in the workspace.

get/workspaces/{workspaceId}/clients/{clientId}

Request

Base URL
https://vetnio.com/api/v2
URL
https://vetnio.com/api/v2/workspaces/{workspaceId}/clients/{clientId}
Auth
HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the workspace (clinic) that owns the patients and clients. The caller must be a member of it; patients and clients are shared by all members of the workspace.

Example:furunculotic-loud-chihuahua

clientIdstring required

Client (owner) id (UUID) in this workspace. Unknown ids and ids from other workspaces return 404.

Example:e1f2a3b4-c5d6-4789-efab-901234567890

Response

Full client record.

idstring required

Client id (UUID), generated by Vetnio.

namestring nullable required

The owner's full name, free text. null when not recorded, for example for the placeholder owner created with a patient that had no owner details.

addressstring nullable required

The owner's street address, free text. null when not recorded.

zipCodestring nullable required

The owner's postal code, free text. null when not recorded.

phoneNumbersstring[] required

The owner's phone numbers, stored as given (no normalisation). E.164 format such as +46701234567 is recommended. Empty array when none are recorded.

emailstring nullable required

The owner's email address. Stored as given; the format is not validated. null when not recorded.

Example response

{
  "id": "e1f2a3b4-c5d6-4789-efab-901234567890",
  "name": "Alex Morgan",
  "address": "12 Harbour Street, Riverside",
  "zipCode": "114 51",
  "phoneNumbers": [
    "+46701234567"
  ],
  "email": "alex.morgan@example.com"
}

Changes

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