VEvetcove
Inbox

Fetch a client communication number

Retrieves a client communication number by its ID.

A client communication number represents a phone number associated with a clinic client (pet parent). Each client can have multiple phone numbers.

get/ext/v2/client-communication-numbers/{client_communication_number_id}/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/client-communication-numbers/{client_communication_number_id}/
  • Auth
    HTTP bearer

Path parameters

client_communication_number_idinteger required

Response

OK

client_idinteger required

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

client_user_idinteger nullable required

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

clinic_idinteger nullable required

The ID of the clinic this phone number belongs to.

createdstring date-time required

The datetime this object was created.

custom_kindstring nullable required

Custom label for the phone number kind.

deletedstring date-time nullable required

The datetime this record was soft deleted.

external_contact_idinteger nullable required

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

idinteger required

The ID of the client communication number record.

is_deletedboolean required

Whether this record is soft deleted or not.

kindstring nullable required

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

modifiedstring date-time required

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

phone_numberinteger required

The phone number as an integer.

sms_enabledboolean required

Whether this phone number can receive SMS messages.

sms_preference'NA' | 'ALL' | 'TRANSACTIONAL' | 'UNSUBSCRIBED' required
verified_atstring date-time nullable required

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

Changes

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