Skip to content
API Docs/
API Reference
/
/
List Automated messages

List Automated messages

Request

Retrieves a list of automated appointment messages.

Security
apiKeyAuth and practiceGroupId
Query
page_indexstring
page_sizestring
orderBystring
Enum:"createdAt""sentAt"
order_descendingstring
Enum:truefalse
recipient_idstring
statusstring or Array of strings
One of:
string
Enum:"INVALIDATED""QUEUED""SENT""SUCCESS""ERROR"
notification_typestring or Array of strings
One of:
string
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/automated_messages?page_index=string&page_size=string&orderBy=createdAt&order_descending=true&recipient_id=string&status=INVALIDATED&notification_type=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
countnumberrequired
Response
{
  "data": [
    { … }
  ],
  "count": 0
}