---
title: "Read resumable onboarding progress"
method: GET
path: "/onboarding"
tags: ["Onboarding"]
---

# Read resumable onboarding progress

`GET /onboarding`

## Request

- Base URL: `https://api.flashdata.dev/v2`
- URL: `https://api.flashdata.dev/v2/onboarding`
- Auth: API key in cookie `__Host-fd_session`

## Response `200`

Current onboarding state

- OnboardingProgress
  - `currentStep` 'welcome' | 'api_key' | 'first_request' | 'completed', required
  - `useCase` 'google_search' | 'youtube_data' | 'download' | 'null', nullable
  - `apiKeyStepStatus` 'pending' | 'created' | 'skipped', required
  - `firstRequestStatus` 'pending' | 'succeeded' | 'skipped', required
  - `firstApiKeyId` string, nullable
  - `firstRequestId` string, nullable
  - `completedAt` string, date-time, nullable
  - `version` integer, required
  - `updatedAt` string, date-time, required

## Other responses

- `401`: Authentication required or invalid
- `500`: An unexpected internal error occurred
- `503`: A required dependency or onboarding record is temporarily unavailable

---

[API](https://skmtc.dev/flashdata/apis/flashdata-customer-api.md) · [All operations](https://skmtc.dev/flashdata/apis/flashdata-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flashdata/apis/flashdata-customer-api/revisions/109179fe9313?raw)