Sign in
Client Communication

Get a list of all Communications with a specific PetParent

Get all appointments

get/api/v1/client-communications

Query parameters

filter[user_id]integer

Id of the related PetParent

filter[patient_ids]integer[]

Ids of the patients that are related to the entity

filter[date_between]string[]

Dates between when the entity was created

filter[content]string

Filter subject and content

filter[email]string

Destination email or users email

Destination phone or users phone

filter[channels]string[]

The channels of the Client Communcations, array of values from CommunicationChannelEnum (e.g. phone, other, email, sms)

filter[types]string[]

The types of the Client Communcations, array of values from CommunicationTypeEnum.

inbound additionally returns threads whose replies contain an inbound message. Results are thread roots, and an inbound email only ever exists as a reply, so it would otherwise be unreachable through this filter.

filter[statuses]string[]

The statuses of the Client Communcations, array of values from CommunicationStatusEnum

filter[is_attached]boolean

  • true - return only communications that are associated with a record.

  • false - return only communications that are not associated with a record.

includestring[]

Additional info to include. You can use multiple, comma separated.

slim_resourceboolean

Return a slim version for related record

Parameters

#/paths/~1api~1v1~1pets/get/parameters/0 — 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

Changes