---
title: "Get dashboard overview"
method: GET
path: "/api/v1/financial-admin-portal/dashboard/"
tags: ["Financial Portal"]
---

# Get dashboard overview

`GET /api/v1/financial-admin-portal/dashboard/`

## Request

- Base URL: `https://docs.thredfi.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.thredfi.com/api/v1/financial-admin-portal/dashboard/`
- Auth: one of:
  - HTTP bearer
  - HTTP basic
  - HTTP bearer
  - HTTP bearer

Returns paginated list of businesses with task metrics. Optimized to handle 50-100 businesses without N+1 queries.

## Response `200`

- DashboardResponse: Serializer for the complete dashboard response.
  - `businesses` DashboardBusiness[], required
    - `business_id` string, uuid, required
    - `business_name` string, required
    - `business_status` string, required
    - `assigned_services` string[], required
    - `metrics` BusinessMetrics, required: Serializer for business task metrics.
      - `open_tasks_count` integer, required
      - `tasks_in_review_count` integer, required
      - `overdue_tasks_count` integer, required
      - `last_activity_date` string, date-time, nullable, required
    - `assignment_info` AssignmentInfo, required: Serializer for business assignment info.
      - `assigned_at` string, date, nullable, required
  - `summary` DashboardSummary, required: Serializer for dashboard summary stats.
    - `total_businesses` integer, required
    - `total_open_tasks` integer, required
    - `total_overdue_tasks` integer, required
  - `pagination` DashboardPagination, required: Serializer for dashboard pagination info.
    - `page` integer, required
    - `page_size` integer, required
    - `total_pages` integer, required
    - `total_count` integer, required

## Other responses

- `400`: Validation errors in request data
- `401`: Authentication required - missing or invalid API key
- `403`: Permission denied - insufficient privileges
- `404`: Resource not found
- `409`: Conflict - resource already exists or invalid state transition
- `422`: Unprocessable entity - business logic validation failed
- `500`: Internal server error

---

[API](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api.md) - [All operations](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thredfi/apis/thredfi-accounting-platform-api/revisions/0c1918254db3?raw)