---
title: "Get onboarding dashboard"
method: GET
path: "/onboarding/v2/dashboard"
tags: ["Onboarding Dashboard"]
---

# Get onboarding dashboard

`GET /onboarding/v2/dashboard`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/onboarding/v2/dashboard`
- Auth: API key in header `OAuth`

Get onboarding dashboard.

## Response `200`

A successful response.

- OnboardingDashboardGetOnboardingDashboardResponse
  - `type` 'SETUP' | 'GET_STARTED'
  - `modules` ModelModule[]
    - `key` string
    - `tasks` ModelTask[]
      - `key` string
      - `status` 'ACTIVE' | 'DONE' | 'DISMISSED'
    - `userTasks` ModelTask[]
      - `key` string
      - `status` 'ACTIVE' | 'DONE' | 'DISMISSED'
  - `routes` ModelRoute[]
    - `key` string
    - `display` 'EXPANDED' | 'COLLAPSED' | 'HIDDEN'

---

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