VEvetcove
Clients And Patients

Search clinic clients

Searches for clinic clients by name, email, phone number, or zip code using structured field-level matching. Email and phone searches match any address or number on the client, not only the primary contact.

A clinic client represents a pet parent at a specific clinic location. Each clinic client belongs to exactly one clinic and can be associated with one or more clinic patients (pets). When the same person visits multiple clinics in the organization, they will have a separate clinic client record at each location, linked by a shared organization client ID.

get/ext/v2/clinic-clients/search/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/clinic-clients/search/
  • Auth
    HTTP bearer

Query parameters

namestring nullable

Searches for clients whose name matches this value. Automatically trimmed and lowercased. Requires name_operator when provided.

name_operator'EXACT' | 'PREFIX' | 'CONTAINS'

The match mode to use for the name field.

emailstring nullable

Searches for clients whose email matches this value. Automatically trimmed and lowercased. Requires email_operator when provided.

email_operator'EXACT' | 'CONTAINS'

The match mode to use for the email field.

phone_numberstring nullable

Searches for clients whose phone number matches this value. Non-numeric characters are automatically stripped. Requires phone_number_operator when provided.

phone_number_operator'EXACT' | 'SUFFIX'

The match mode to use for the phone_number field.

zip_codestring nullable

Searches for clients whose zip code matches this value. Automatically trimmed and lowercased. Requires zip_code_operator when provided.

zip_code_operator'EXACT' | 'PREFIX' | 'CONTAINS'

The match mode to use for the zip_code field.

is_activeboolean nullable

Filters to clients with the given active status.

pageinteger

The page number to return.

page_sizeinteger

The number of results per page.

Response

OK

has_moreboolean

Whether there are more pages or data in this list.

next_pagestring required

A URL linking to the next page of this list.

typestring

Type of this object. Always list.

Changes

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