Skip to content
API reference/
API Reference
/
/
List Episodes (v2)

List Episodes (v2)

Request

Retrieves a list of all episodes for a practice group.

Security
apiKeyAuth and practiceGroupId
Query
page_indexinteger
page_sizeinteger
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"
order_by[]Array of strings
Items Enum:"created_at""priority"
order_descending[]Array of strings
patient_idstring

Only the episodes of this patient (an id from GET /v2/episodes/patients).

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v2/episodes?page_index=0&page_size=0&assignee_id%5B%5D=string&assignee_type%5B%5D=Admin&status%5B%5D=open&priority%5B%5D=lowest&order_by%5B%5D=created_at&order_descending%5B%5D=string&patient_id=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

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