clients

List clients (owners)

Returns every client (owner) in the workspace in one unpaginated response, in no guaranteed order, including the empty placeholder owners created with patients that had no owner details. Clients do not embed their patients; search the patient list by the owner's name to find them (each patient carries clientId).

get/workspaces/{workspaceId}/clients

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/clients
  • 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

Response

List of all clients in the workspace.

Example response

{
  "clients": [
    {
      "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.