Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Vets

List all Vets

Permissions needed: ACCESS_PATIENTS Returns the Vet list from a clinic

get/api/v1/vets

Query parameters

filter[clinic_id]string required

Clinic IDs (comma separated)

filter[id]integer[]

Ids of the entities that are related to the endpoint

filter[query]string

Search query string

filter[email]string

Vet email

filter[active]boolean

Filter only by vets that are active. Exclude to get all vets.

filter[status]0 | 1

0 - Inactive 1 - Active

filter[is_available_for_appointments]boolean
filter[is_visible_on_calendar]boolean
filter[vet_role_id]string
filter[available_between]string

Filter by availability. Format: YYYY-MM-DD,YYYY-MM-DD or YYYY-MM-DD

filter[type]'veterinarian' | 'technician' | 'groomer' | 'practice_manager' | 'receptionist' | 'support_staff'
filter[visit_type_id]string

Filter by visit type ID

filter[booking_status]'inactive' | 'staffing_only' | 'internal_needs_setup' | 'internal_ready' | 'online_needs_setup' | 'online_ready'

Filter by booking status

filter[team_id]string

Filter by team ID

includestring

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

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

Parameters

#/paths/~1api~1v1~1pets/get/parameters/1 — unresolved $ref
#/paths/~1api~1v1~1tags/get/parameters/4 — unresolved $ref
#/paths/~1api~1v1~1tags/get/parameters/5 — unresolved $ref
#/paths/~1api~1v1~1pets/get/parameters/11 — unresolved $ref

Response

successful operation

dataData[] — unresolved $ref
linksLinks — unresolved $ref
metaMeta — unresolved $ref