Get a list of all Communications with a specific PetParent

1 min

GET

https://developer.digitail.io/api/v1/client-communications

Get all appointments

filter[user_id]integerId of the related PetParent

filter[patient_ids]arrayIds of the patients that are related to the entity

filter[date_between]arrayDates between when the entity was created

filter[content]stringFilter subject and content

filter[email]stringDestination email or users email

filter[phone]Destination phone or users phone

filter[channels]arrayThe channels of the Client Communcations, array of values from CommunicationChannelEnum (e.g. phone, other, email, sms)

filter[types]arrayThe types of the Client Communcations, array of values from CommunicationTypeEnum. <code>inbound</code> 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]arrayThe statuses of the Client Communcations, array of values from CommunicationStatusEnum

filter[is_attached]boolean<ul> <li> <code>true</code> - return only communications that are associated with a record. </li> <li> <code>false</code> - return only communications that are not associated with a record. </li> </ul>

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

slim_resourcebooleanReturn a slim version for related record

acceptstringGenerated from available response content types

200successful operation

curl --request GET \
     --url https://developer.digitail.io/api/v1/client-communications \
     --header 'accept: application/json'