VEvetnio
vettigo

Vettigo integration status

Returns whether the calling user has a Vettigo account linked to Vetnio. The link is created when the user first opens Vetnio from inside Vettigo, cannot be set up through the REST API, and is the same in every workspace. Use it to decide whether to offer Vettigo features. Never fails: any problem is reported as connected: false.

get/workspaces/{workspaceId}/vettigo/status

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/vettigo/status
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the Vetnio workspace (clinic). The caller must be a member. The Vettigo clinic used is the one the caller last launched Vetnio from, not something configured on the workspace.

Example:furunculotic-loud-chihuahua

Response

Vettigo connection status.

connectedboolean required

true when the calling user has a Vettigo account linked to Vetnio, which happens the first time they open Vetnio from Vettigo. The other Vettigo endpoints return 401 while this is false. Also false when the status could not be determined.

ehrIntegrationNamestring nullable required

Name of the connected practice-management system: always vettigo when connected is true, otherwise null.

Example response

{
  "connected": true,
  "ehrIntegrationName": "vettigo"
}

Changes

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