Fetch a client communication number

GET

ext

client-communication-numbers

{client_communication_number_id}

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/', 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/client-communication-numbers/{client_communication_number_id}/",
  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/client-communication-numbers/{client_communication_number_id}/"

	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))

}

HttpResponse<String> response = Unirest.get("https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/")

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

{
  "client_id": 123,
  "client_user_id": 123,
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "custom_kind": "<string>",
  "deleted": "2023-11-07T05:31:56Z",
  "external_contact_id": 123,
  "id": 123,
  "is_deleted": true,
  "kind": "<string>",
  "modified": "2023-11-07T05:31:56Z",
  "phone_number": 123,
  "sms_enabled": true,
  "sms_preference": "NA",
  "verified_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

client_communication_number_id

integer

required

Response

200 - application/json

client_id

integer

required

The ID of the clinic client this phone number belongs to.

client_user_id

integer | null

required

The ID of the client user this phone number is tied to.

clinic_id

integer | null

required

The ID of the clinic this phone number belongs to.

created

string<date-time>

required

The datetime this object was created.

custom_kind

string | null

required

Custom label for the phone number kind.

deleted

string<date-time> | null

required

The datetime this record was soft deleted.

external_contact_id

integer | null

required

The ID of the external contact this phone number is tied to.

integer

required

The ID of the client communication number record.

is_deleted

boolean

required

Whether this record is soft deleted or not.

kind

string | null

required

The kind of phone number (e.g. Mobile, Home, Work, Other).

modified

string<date-time>

required

The datetime this object was last modified; changes to related entities will not update this field.

phone_number

integer

required

The phone number as an integer.

sms_enabled

boolean

required

Whether this phone number can receive SMS messages.

sms_preference

enum<string>

required

Client's SMS preference:

NA: Not applicable or unknown.
ALL: Receive all SMS notifications.
TRANSACTIONAL: Only critical transactional notifications (e.g. password reset, onboarding, checkout).
UNSUBSCRIBED: Do not send any SMS messages.

Available options:

NA,

ALL,

TRANSACTIONAL,

UNSUBSCRIBED

verified_at

string<date-time> | null

required

When the client verified access to this phone number, if at all.

⌘I

Fetch a client communication number

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/', 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/client-communication-numbers/{client_communication_number_id}/",
  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/client-communication-numbers/{client_communication_number_id}/"

	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))

}

HttpResponse<String> response = Unirest.get("https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/")

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

{
  "client_id": 123,
  "client_user_id": 123,
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "custom_kind": "<string>",
  "deleted": "2023-11-07T05:31:56Z",
  "external_contact_id": 123,
  "id": 123,
  "is_deleted": true,
  "kind": "<string>",
  "modified": "2023-11-07T05:31:56Z",
  "phone_number": 123,
  "sms_enabled": true,
  "sms_preference": "NA",
  "verified_at": "2023-11-07T05:31:56Z"
}

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

Fetch a client communication number

Authorizations

Path Parameters

Response