---
title: "Get Dashboard Data"
method: GET
path: "/api/v1/mobile/dashboard/{participant_id}"
tags: ["Mobile - Dashboard"]
---

# Get Dashboard Data

`GET /api/v1/mobile/dashboard/{participant_id}`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v1/mobile/dashboard/{participant_id}`
- Auth: none declared. Required headers: `authorization`

Get aggregated dashboard data including participant info, plan details, budget summary, and recent claims.

## Path parameters

- `participant_id` string, required: Participant ID

## Headers

- `authorization` string, required: Bearer token

## Response `200`

Successful Response

- DashboardResponse: Combined dashboard data response.
  - `participant` AppSchemasMobileParticipantInfo, required: Participant info for dashboard.
    - `id` string, required
    - `first_name` string, required
    - `last_name` string, required
    - `participant_number` integer, nullable
  - `plan` PlanInfo, required: Plan information for dashboard.
    - `start_date` string, nullable
    - `end_date` string, nullable
    - `days_remaining` integer, nullable
    - `days_elapsed` integer, nullable
    - `total_days` integer, nullable
    - `is_pace_plan` boolean
  - `budget_summary` BudgetSummary, required: Aggregated budget summary for dashboard.
    - `total_approved` number
    - `total_spent` number
    - `total_remaining` number
    - `spend_percentage` number
    - `average_weekly_spend` number
    - `available_weekly_spend` number
  - `recent_claims` RecentClaim[]
    - `id` integer, required
    - `provider_name` string, nullable
    - `date` string, nullable
    - `amount` number
    - `status` string
  - `spend_by_type` SpendByTypeMonth[]
    - `month` string, required
    - `core` number
    - `capital` number
    - `capacity_building` number
    - `total` number
  - `top_providers` TopProvider[]
    - `id` string, nullable: Provider ID
    - `name` string, required: Provider name
    - `total_spend` number: Total spend amount
    - `invoice_count` integer: Number of invoices
  - `alerts` object[]

## Other responses

- `401`: Unauthorized
- `403`: Access denied
- `404`: Participant not found
- `422`: Validation Error
- `500`: Internal server error

---

[API](https://skmtc.dev/caresquare/apis/caresquare-api.md) - [All operations](https://skmtc.dev/caresquare/apis/caresquare-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caresquare/apis/caresquare-api/revisions/d428fe38bf62?raw)