Clinic clients

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

clinic-clients

Search clinic clients

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/clinic-clients/search/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/clinic-clients/search/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/clinic-clients/search/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/clinic-clients/search/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinic-clients/search/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "can_be_called": true,
      "client_notes": "<string>",
      "clinic_id": 123,
      "created": "2023-11-07T05:31:56Z",
      "deleted": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "has_multiple_users": true,
      "has_unread_messages_for_clinic": true,
      "id": 123,
      "is_active": true,
      "is_deleted": true,
      "is_email_unsubscribed": true,
      "is_subscribed": true,
      "last_visit_date": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "organization_client_id": 123,
      "pim_id": "<string>",
      "primary_client_user_id": 123,
      "secondary_emails": [
        "<string>"
      ],
      "secondary_phone_numbers": [
        123
      ],
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone_number": 123,
      "primary_address": {
        "address_one": "<string>",
        "city": "<string>",
        "id": 123,
        "state": "<string>",
        "zipcode": "<string>",
        "address_two": "",
        "country": "US",
        "county": "",
        "name": "",
        "phone_number": 123
      },
      "primary_payment_method_id": 123
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

name

string | null

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

name_operator

enum<string> | null

The match mode to use for the name field.

Available options:

EXACT,

PREFIX,

CONTAINS

string | null

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

email_operator

enum<string> | null

The match mode to use for the email field.

Available options:

EXACT,

CONTAINS

phone_number

string | null

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

phone_number_operator

enum<string> | null

The match mode to use for the phone_number field.

Available options:

EXACT,

SUFFIX

zip_code

string | null

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

zip_code_operator

enum<string> | null

The match mode to use for the zip_code field.

Available options:

EXACT,

PREFIX,

CONTAINS

is_active

boolean | null

Filters to clients with the given active status.

page

integer

default:1

The page number to return.

Required range: x >= 1

page_size

integer

default:20

The number of results per page.

Required range: 1 <= x <= 100

Response

200 - application/json

data

ExternalClinicClientSearchSchema · object[]

required

A single page of data contained within this list.

Show child attributes

next_page

string

required

A URL linking to the next page of this list.

has_more

boolean

default:false

Whether there are more pages or data in this list.

type

string

default:list

Type of this object. Always list.

⌘I

Search clinic clients

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/clinic-clients/search/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/clinic-clients/search/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/clinic-clients/search/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/clinic-clients/search/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/clinic-clients/search/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "can_be_called": true,
      "client_notes": "<string>",
      "clinic_id": 123,
      "created": "2023-11-07T05:31:56Z",
      "deleted": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "has_multiple_users": true,
      "has_unread_messages_for_clinic": true,
      "id": 123,
      "is_active": true,
      "is_deleted": true,
      "is_email_unsubscribed": true,
      "is_subscribed": true,
      "last_visit_date": "2023-11-07T05:31:56Z",
      "modified": "2023-11-07T05:31:56Z",
      "organization_client_id": 123,
      "pim_id": "<string>",
      "primary_client_user_id": 123,
      "secondary_emails": [
        "<string>"
      ],
      "secondary_phone_numbers": [
        123
      ],
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone_number": 123,
      "primary_address": {
        "address_one": "<string>",
        "city": "<string>",
        "id": 123,
        "state": "<string>",
        "zipcode": "<string>",
        "address_two": "",
        "country": "US",
        "county": "",
        "name": "",
        "phone_number": 123
      },
      "primary_payment_method_id": 123
    }
  ],
  "next_page": "<string>",
  "has_more": false,
  "type": "list"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Search clinic clients

Authorizations

Query Parameters

Response