List all Vets

1 min

GET

https://developer.digitail.io/api/v1/vets

Permissions needed: ACCESS_PATIENTS Returns the Vet list from a clinic

Query Parameters

filter[clinic_id]stringrequired
Description
Clinic IDs (comma separated)
filter[id]integer[]
Description
Ids of the entities that are related to the endpoint
filter[query]string
Description
Search by the vet's first and last name
filter[name_or_email]string
Description
Search by the vet's first and last name, or by part of their email
filter[email]string
Description
Vet email
filter[active]boolean
Description
Filter only by vets that are active. Exclude to get all vets.
Allowed
active
filter[status]integer
Description
0 - Inactive 1 - Active
Allowed
01
filter[is_available_for_appointments]boolean
filter[is_visible_on_calendar]boolean
filter[vet_role_id]string
filter[available_between]string
Description
Filter by availability. Format: YYYY-MM-DD,YYYY-MM-DD or YYYY-MM-DD
filter[type]string
Allowed
veterinariantechniciangroomerpractice_managerreceptionistsupport_staff
filter[visit_type_id]string
Description
Filter by visit type ID
filter[booking_status]string
Description
Filter by booking status
Allowed
inactivestaffing_onlyinternal_needs_setupinternal_readyonline_needs_setuponline_ready
filter[team_id]string
Description
Filter by team ID
includestring
Description
Additional info to include. You can use multiple, comma separated. Options: multipleClinic, multipleClinic.rooms, vetRolesAll, services, visitTypes, employee.chatUser, employees.teams, colleague_order, shifts, employees.vet.visitTypes, employees.vet.shifts, employees.clinic. employee.chatUser manages has_chat_user attribute, true if chatUser is active, false if non-existent or inactive
sortstring
Description
Order by field(s) (status, first_name, last_name, colleague_order, type) Use a minus before for descending order -status. type orders by the staff type at the clinic given in filter[clinic_id], in the order veterinarian, technician, practice_manager, receptionist, groomer, support_staff — staff with no type come last.

Responses

200successful operation

object
- datadata[]
- linkslinks
- metameta

curl

curl --request GET \
     --url 'https://developer.digitail.io/api/v1/vets?filter[clinic_id]=string' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/vets?filter[clinic_id]=string", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/vets?filter[clinic_id]=string")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/vets?filter[clinic_id]=string"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// successful operation
{
  "data": [
    ""
  ],
  "links": {},
  "meta": {}
}