Skip to main content
GET
Fetch a clinic

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

clinic_id
integer
required

The ID of the clinic to fetch

Response

200 - application/json

OK

Clinics represent a physical site where clients (pet owners) can go seek care for patients (their pets).

base_url
string
required

The base URL for the Vetcove client shopping portal. Respects custom/vanity shop domains when configured. This is the same base_url returned by auto-auth, without an auto-auth token.

billing_address
ExternalAddressSchema · object | null
required

The billing address of the clinic.

booking_url
string
required

The URL of this clinic's current client-facing appointment booking page. Respects custom/vanity shop domains when configured.

client_display_name
string
required

The display name of this clinic shown to clients.

clinic_timezone
string
required

The IANA timezone identifier where this clinic is located.

created
string<date-time>
required

The datetime this object was created.

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

group_location_code
string | null
required

The group location code of the clinic location group. Group location codes are a group's internal identifier for their clinics.

id
integer
required

The unique identifier for the clinic.

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_pims
boolean
required

Whether this clinic is PIMS-enabled or not.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

name
string
required

The name of this clinic.

phone_number
integer | null
required

The phone number of the clinic.

primary_address
ExternalAddressSchema · object | null
required

The primary address of the clinic.

website_url
string | null
required

The website url of the clinic.

email
string | null

The email address of the clinic.