List all Vets

1 min

GET

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

Permissions needed: ACCESS_PATIENTS Returns the Vet list from a clinic

filter[clinic_id]stringClinic IDs (comma separated)

filter[id]arrayIds of the entities that are related to the endpoint

filter[query]stringSearch query string

filter[email]stringVet email

filter[active]booleanFilter only by vets that are active. Exclude to get all vets.

filter[status]integer<code>0</code> - Inactive <code>1</code> - Active

filter[is_available_for_appointments]boolean

filter[is_visible_on_calendar]boolean

filter[vet_role_id]string

filter[available_between]stringFilter by availability. Format: YYYY-MM-DD,YYYY-MM-DD or YYYY-MM-DD

filter[type]string

filter[visit_type_id]stringFilter by visit type ID

filter[booking_status]stringFilter by booking status

filter[team_id]stringFilter by team ID

includestringAdditional 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

sortstringOrder by field(s) (status, first_name, last_name, colleague_order) Use a minus before for descending order -status

acceptstringGenerated from available response content types

200successful operation

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