# List Episodes

Retrieves a list of all episodes for a practice group.

Endpoint: GET /v1/episodes
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `practiceGroupId` (unknown)
    apiKey in header x-practice-group-id

## Query parameters:

  - `page_index` (integer)

  - `page_size` (integer)

  - `assignee_id[]` (array)

  - `assignee_type[]` (array)

  - `status[]` (array)

  - `priority[]` (array)

  - `order_by[]` (array)

  - `order_descending[]` (array)

## Response 200:

  - `200` (unknown)
    Ok

## Response 200 fields (application/json):

  - `count` (number, required)

  - `data` (array, required)

  - `data.id` (string, required)

  - `data.status` (string, required)
    Enum: "open", "closed", "in_progress"

  - `data.priority` (string, required)
    Enum: "lowest", "low", "medium", "high", "highest"

  - `data.assignees` (array)

  - `data.assignees.type` (string, required)
    Enum: "Admin", "AdminTeam", "Unassigned"

  - `data.assignees.id` (string, required)

  - `data.assignees.name` (string, required)

  - `data.tasks` (array)

  - `data.tasks.id` (string, required)

  - `data.tasks.type_label` (string, required)

  - `data.tasks.status` (string, required)
    Enum: "open", "closed", "in_progress"

  - `data.tasks.details` (string)

  - `data.tasks.category` (string, required)

  - `data.tasks.patient` (object, required)

  - `data.tasks.patient.id` (string, required)

  - `data.tasks.patient.uid` (string)

  - `data.tasks.patient.full_name` (string)

  - `data.tasks.note` (object)

  - `data.tasks.note.id` (number, required)

  - `data.tasks.note.description` (string, required)

  - `data.tasks.note.admin` (object, required)

  - `data.tasks.note.admin.id` (number, required)

  - `data.tasks.note.admin.first_name` (string, required)

  - `data.tasks.note.admin.last_name` (string, required)

  - `data.tasks.note.admin.full_name` (string, required)

  - `data.tasks.note.practice_group_id` (number, required)

  - `data.tasks.note.archived_at` (string, required)

  - `data.tasks.note.created_at` (string, required)

  - `data.tasks.note.updated_at` (string, required)

  - `data.tasks.assignee_id` (string)

  - `data.tasks.assignee_type` (string)

  - `data.tasks.assignee_name` (string)

  - `data.tasks.priority` (string, required)
    Enum: "lowest", "low", "medium", "high", "highest"

  - `data.tasks.created_at` (string, required)

  - `data.tasks.title` (string, required)

  - `data.tasks.title_sub_text` (string, required)

  - `data.patient` (object, required)

  - `data.patient.id` (string)

  - `data.patient.uid` (string)

  - `data.patient.title` (string)

  - `data.patient.first_name` (string)

  - `data.patient.last_name` (string)

  - `data.category` (string, required)

  - `data.label` (string, required)

  - `data.description` (string, required)

  - `data.created_at` (string, required)

  - `data.updated_at` (string, required)

## Response 400:

  - `400` (unknown)
    Validation error

## Response 400 fields (application/json):

  - `error` (boolean, required)
    Example: true

  - `statusCode` (number, required)
    Example: 400

  - `message` (array, required)

  - `message.code` (string, required)
    Example: invalid_type

  - `message.expected` (string, required)
    Example: string

  - `message.path` (array, required)
    Example: ["patient_id"]

  - `message.message` (string, required)
    Example: Required

## Response 401:

  - `401` (unknown)
    Unauthorised

## Response 404:

  - `404` (unknown)
    Not found

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 500:

  - `500` (unknown)
    Unknown error