Skip to content
API reference/
/Episode

Episode

Manage clinical episodes — containers for related patient interactions and messages.

Operations

Count Episodes

Request

Retrieves a count of all episodes for a practice group.

Security
apiKeyAuth and practiceGroupId
Query
assignee_id[]Array of strings
assignee_type[]Array of strings
Items Enum:"Admin""AdminTeam""Unassigned"
status[]Array of strings
Items Enum:"open""closed""in_progress"
priority[]Array of strings
Items Enum:"lowest""low""medium""high""highest"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/episodes/count?assignee_id%5B%5D=string&assignee_type%5B%5D=Admin&status%5B%5D=open&priority%5B%5D=lowest' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
countnumberrequired
Response
{
  "count": 0
}