---
title: "Get Memory Overview"
method: GET
path: "/v1/matters/{matter_id}/memory"
tags: ["memory"]
---

# Get Memory Overview

`GET /v1/matters/{matter_id}/memory`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/memory`
- Auth: HTTP bearer

## Path parameters

- `matter_id` string, uuid, required

## Query parameters

- `include_progress` boolean

## Response `200`

Successful Response

- MemoryOverview
  - `matter_id` string, uuid, required
  - `connection` MemoryConnectionSummary, required
    - `status` string, required
  - `source` MemorySourceSummary, required
    - `home_kind` 'sharepoint' | 'ender', required
    - `status` string, required
    - `display_name` string, nullable, required
    - `root_path` string, nullable, required
    - `last_sync_at` string, date-time, nullable, required
    - `last_inventory_at` string, date-time, nullable, required
    - `sync_state` string, required
    - `subscription_state` string, required
    - `subscription_expires_at` string, date-time, nullable, required
  - `document_home` union, required
    - MemoryDocumentHomeNotConfigured
      - `state` 'not_configured', required
    - MemoryDocumentHomePreparing
      - `state` 'preparing', required
      - `home_kind` 'sharepoint' | 'ender', required
    - MemoryDocumentHomeActive
      - `state` 'active', required
      - `home_kind` 'sharepoint' | 'ender', required
    - MemoryDocumentHomeUnavailable
      - `state` 'unavailable', required
      - `home_kind` 'sharepoint' | 'ender', required
  - `freshness` MemoryFreshnessSummary, required
    - `state` string, required
    - `updated_at` string, date-time, nullable, required
  - `corpus` MemoryCorpusSummary, required
    - `availability` string, required
    - `document_count` integer, required
    - `ready_count` integer, required
    - `issue_count` integer, required
    - `stale_count` integer, required
    - `updating_count` integer, required
  - `progress` MemoryProgressSummary, required
    - `provider_kind` 'sharepoint' | 'onedrive', nullable, required
    - `source_id` string, uuid, nullable, required
    - `activity_id` string, uuid, nullable, required
    - `run_id` string, uuid, nullable, required
    - `producer_key` 'xero', nullable, required
    - `activity_kind` 'import' | 'inventory' | 'processing' | 'retry' | 'sync', required
    - `change_count` integer, nullable, required
    - `status` string, required
    - `mode` string, required
    - `phase` string, required
    - `current` integer, required
    - `total` integer, required
    - `percent` integer, nullable, required
    - `retrying` boolean, required
    - `ready_count` integer, required
    - `processing_count` integer, required
    - `retrying_count` integer, required
    - `failed_count` integer, required
    - `updated_at` string, date-time, required
    - `finished_at` string, date-time, nullable, required
  - `activities` MemoryProgressSummary[], required
    - `provider_kind` 'sharepoint' | 'onedrive', nullable, required
    - `source_id` string, uuid, nullable, required
    - `activity_id` string, uuid, nullable, required
    - `run_id` string, uuid, nullable, required
    - `producer_key` 'xero', nullable, required
    - `activity_kind` 'import' | 'inventory' | 'processing' | 'retry' | 'sync', required
    - `change_count` integer, nullable, required
    - `status` string, required
    - `mode` string, required
    - `phase` string, required
    - `current` integer, required
    - `total` integer, required
    - `percent` integer, nullable, required
    - `retrying` boolean, required
    - `ready_count` integer, required
    - `processing_count` integer, required
    - `retrying_count` integer, required
    - `failed_count` integer, required
    - `updated_at` string, date-time, required
    - `finished_at` string, date-time, nullable, required
  - `issues` MemoryIssueSummary[], required
    - `code` string, required
    - `scope` string, required
    - `document_name` string, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/a5849ac366ca?raw)