---
title: "Get the gamification status and the details of available gamification tasks"
method: GET
path: "/onboarding/v2/gamification/status"
tags: ["Onboarding Gamification"]
---

# Get the gamification status and the details of available gamification tasks

`GET /onboarding/v2/gamification/status`

## Request

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

Get the gamification status and the details of available gamification tasks.

## Response `200`

A successful response.

- OnboardingGamificationGetGamificationStatusResponse
  - `success` boolean
  - `data` ModelGamificationInfo
    - `gamificationStatus` ModelGamificationStatus
      - `isGamificationEnabled` boolean: Whether the gamification feature is enabled for this trial. Will be false if the install is not in trial.
      - `trialDaysLeft` integer
      - `trialEndDate` string, date-time
      - `signupPlatform` 'WEB' | 'MOBILE_APP' | 'API'
    - `gamificationTasks` ModelGamificationTask[]
      - `name` 'BUSINESS_NAME' | 'SCHEDULING_RULES' | 'INVITE_EMPLOYEE' | 'PUBLISH_ROSTER' | 'APPROVE_TIMESHEET' | 'MOBILE_NUMBER' | 'EXPLORE_ECOSYSTEM' | 'BOOK_DEMO' | 'PAID'
      - `isCompleted` boolean
      - `trialDaysGiven` integer
      - `sortOrder` integer: Sort order for displaying the task in FE. May vary depending on the trial signup intent.
      - `completedAt` string, date-time

---

[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)