---
title: "Client Summary"
method: GET
path: "/api/adviser/clients/{user_id}/summary"
tags: ["Adviser"]
---

# Client Summary

`GET /api/adviser/clients/{user_id}/summary`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/adviser/clients/{user_id}/summary`
- Auth: HTTP bearer

Period expenditure totals by pot/category. category_totals scope suffices.

## Path parameters

- `user_id` string, uuid, required

## Query parameters

- `months` integer

## Response `200`

Successful Response

- ClientSummaryResponse
  - `user_id` string, required
  - `client_label` string, required
  - `period_start` string, date, required
  - `period_end` string, date, required
  - `months` integer, required
  - `total_expenditure` number, required
  - `pots` AppApiAdviserPotSummary[], required
    - `pot` string, required
    - `label` string, required
    - `total` number, required
    - `categories` AppApiAdviserCategorySummary[], required
      - `category` string, required
      - `total` number, required
  - `monthly` MonthlyPoint[], required
    - `month` string, required
    - `expenditure` number, required
    - `income` number, required
    - `net` number, required
    - `by_pot` object, required
    - `by_category` MonthlyCategory[], required
      - `category` string, required
      - `total` number, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)