---
title: "GET /v1/auth/onboarding"
method: GET
path: "/v1/auth/onboarding"
---

# GET /v1/auth/onboarding

`GET /v1/auth/onboarding`

## Response `200`

- ClientUserEntity
  - `id` number, required
  - `firstName` string, required
  - `lastName` string, required
  - `address` string, required
  - `profilePicture` string, required
  - `email` string, required
  - `password` string, required
  - `address2` string, required
  - `city` string, required
  - `postcode` string, required
  - `country` string, required
  - `state` string, required
  - `cc` number, required
  - `phone` string, required
  - `activationHash` string, required
  - `activationEmailResentAt` string, date-time, required
  - `passwordLockedAt` string, date-time, required
  - `accountStatus` object, required
  - `emailVerified` boolean, required
  - `timezone` string, required
  - `registeredIp` string, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `aid` string, required
  - `emailList` object, required
  - `onboardingCompleted` number, required
  - `lastCheckedForInactivity` string, date-time, required
  - `receiveNewsletters` number, required
  - `lastLogin` string, date-time, required
  - `gitHubId` number, required
  - `googleId` number, required
  - `clients` ClientEntity[], required
    - `id` number, required
    - `name` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `stripeId` string, required
    - `stripePaymentId` string, required
    - `defaultApp` number, required
    - `clientUsers` ClientUserEntity[], required
    - `clientUserClients` ClientUserClientsEntity[], required
      - `mappingId` number, required
      - `role` object, required
      - `clientUser` ClientUserEntity, required — recursive
      - `client` ClientEntity, required — recursive
    - `licenseKey` string
    - `licensePublicKey` string
    - `licenseAuthToken` string
    - `status` 'active' | 'send_suspended' | 'suspended', required
    - `version` string
    - `region` string
  - `clientUserClients` ClientUserClientsEntity[], required
    - `mappingId` number, required
    - `role` object, required
    - `clientUser` ClientUserEntity, required — recursive
    - `client` ClientEntity, required
      - `id` number, required
      - `name` string, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `stripeId` string, required
      - `stripePaymentId` string, required
      - `defaultApp` number, required
      - `clientUsers` ClientUserEntity[], required
      - `clientUserClients` ClientUserClientsEntity[], required
      - `licenseKey` string
      - `licensePublicKey` string
      - `licenseAuthToken` string
      - `status` 'active' | 'send_suspended' | 'suspended', required
      - `version` string
      - `region` string
  - `source` string
  - `isTwoFactorEnabled` number, required
  - `twoFactorSecret` string
  - `passwordResetRequestedAt` string, date-time, required

---

[API](https://skmtc.net/engagespot/apis/engagespot-api.md) · [All operations](https://skmtc.net/engagespot/apis/engagespot-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/engagespot/engagespot-api/revisions/33fd027f0b5f/schema)