---
title: "List Onboarding"
method: GET
path: "/api/v1/gtm/onboarding"
tags: ["GTM - Onboarding"]
---

# List Onboarding

`GET /api/v1/gtm/onboarding`

## Request

- Base URL: `https://api.gemstoneaiapp.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gemstoneaiapp.com/api/v1/gtm/onboarding`
- Auth: none declared

## Query parameters

- `status` string, nullable: active | completed | all
- `limit` integer

## Headers

- `x-admin-key` string, nullable

## Response `200`

Successful Response

- CustomerOnboardingListResponse
  - `total` integer, required
  - `items` CustomerOnboardingResponse[], required
    - `id` integer, required
    - `dealer_customer_id` string, required
    - `prospect_id` integer, nullable
    - `onboarding_started_at` string, date-time, required
    - `milestones_hit` object[]
    - `onboarding_completed_at` string, date-time, nullable
    - `churn_risk_score` number, nullable
    - `churn_risk_updated_at` string, date-time, nullable
    - `plan_tier` string, nullable
    - `mrr` string, nullable
    - `nps_score` integer, nullable
    - `testimonial_status` string, nullable

## Other responses

- `422`: Validation Error

---

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