Skip to content
API Docs/
API Reference
/
/
List Batch Message Recipi...

List Batch Message Recipients

Request

List Batch Message Recipients

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Query
page_sizeinteger
page_indexinteger
statusstring
Enum:"CREATED""ENRICHMENT_ERROR""ENRICHED""INVALID_PAYLOAD""QUEUED"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/batch_message/{id}/recipients?page_size=0&page_index=0&status=CREATED' \
  -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
}