---
title: "Get home summary"
method: GET
path: "/workspaces/{workspace_id}/home"
tags: ["Home"]
---

# Get home summary

`GET /workspaces/{workspace_id}/home`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/home`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Deterministic authenticated read for the Home surface — an app usage snapshot plus structured, pinnable health issues. Not a chat turn.

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

## Query parameters

- `project_id` integer, nullable: The project the empty chat looks in: the data starters come from it. Without one, from the most recently updated project.

## Response `200`

Home summary

- HomeSummarySchema
  - `usage_summary` AppUsageFieldSchema, required
    - `storage_used` integer, nullable: Total storage used by the workspace
    - `current_storage_allowed` integer, nullable: Current storage allowed for the workspace
    - `plan_storage_value` integer, nullable: Initial storage offered by the plan
    - `max_storage_allowed` integer, nullable: Maximum storage allowed that can be allowed for the workspace with current plan and addons
    - `row_count_utilized` integer, nullable: Total row count utilized by the workspace
    - `current_row_count_allowed` integer, nullable: Current row count allowed for the workspace
    - `plan_row_count_value` integer, nullable: Initial row count offered by the plan
    - `max_row_count_allowed` integer, nullable: Maximum row count allowed that can be allowed for the workspace with current plan and addons
  - `health_issues` HealthIssueSchema[], required
    - `issue_type` 'connector_auth_failure' | 'delivery_failure' | 'all_clear', required
    - `occurrence_count` integer, required
    - `severity` 'critical' | 'warning' | 'info', required
    - `reason_code` string, required
    - `available_actions` string[], required
    - `basis` string[], required
  - `suggestions` SuggestionsSchema, required
    - `entry_state` 'new' | 'returning' | 'power', required: How far into the product this workspace is, which decides what to offer.
    - `groups` SuggestionGroupSchema[], required
      - `key` string, nullable
      - `items` SuggestionItemSchema[], required
        - `key` string, required
        - `mode` string, required
        - `dest` string, required
        - `icon` string, required
        - `params` object
    - `continue_chat` ContinueChatSchema
      - `session_id` string, required
      - `session_name` string, nullable
      - `replies` string[], required
    - `starters` DataStarterSchema[]
      - `key` 'export_failed' | 'refresh_failed' | 'blank_values' | 'dataset_updated', required
      - `params` object, required

## Other responses

- `400`: Bad Request
- `401`: Authorization error

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)