---
title: "Onboarding & Feature Modules API — SpireStock REST API"
description: "Switch a workspace's optional modules on or off, read the Get Started checklist, and record each user's product-tour progress."
source: https://developers.spirestock.com/api-reference/onboarding
---

# Onboarding & Feature Modules API

Switch a workspace's optional modules on or off, read the Get Started checklist, and record each user's product-tour progress.

Base URL: `https://api.spirestock.com/api/v1`. Every request needs an API key (`X-API-Key`) or a session token (`Authorization: Bearer`); see https://developers.spirestock.com/api-reference/auth.

## Endpoints

- [GET /workspace/features](https://developers.spirestock.com/api-reference/onboarding#get-workspace-features)
- [PUT /workspace/features](https://developers.spirestock.com/api-reference/onboarding#put-workspace-features)
- [GET /dashboard/onboarding](https://developers.spirestock.com/api-reference/onboarding#get-dashboard-onboarding)
- [GET /auth/me/onboarding](https://developers.spirestock.com/api-reference/onboarding#get-auth-me-onboarding)
- [PUT /auth/me/onboarding](https://developers.spirestock.com/api-reference/onboarding#put-auth-me-onboarding)

## GET /workspace/features

Which optional modules (crates, logistics, tracking, wallet and so on) are switched on for the workspace. modules maps every module key to true or false; core lists the areas that are always on; catalogue describes each module; source says how the set was decided (default, derived, existing, admin) and decided_at when; can_edit is true for administrators. A workspace created before feature modules existed gets every module on, stored on first read with source existing.

Access: API key `read` scope; any staff user (reference data).

**Example request**

```bash
curl https://api.spirestock.com/api/v1/workspace/features \
  -H "X-API-Key: YOUR_API_KEY"
```

**Example response**

```json
{
  "response_code": 200,
  "data": {
    "modules": {
      "crates": true,
      "logistics": true,
      "tracking": true,
      "hr": true,
      "field_sales": true,
      "accounts": true,
      "wallet": true,
      "credit_risk": true,
      "expenses": true,
      "incentives": true,
      "gamification": true,
      "batches": true,
      "returns": true,
      "foc": true,
      "sales_intelligence": true,
      "subscriptions": true,
      "scheduled_reports": true,
      "developer": true
    },
    "source": "existing",
    "decided_at": "2026-10-22T08:12:26.563Z",
    "core": [
      "dashboard",
      "orders",
      "customers"
    ],
    "catalogue": [
      {
        "key": "crates",
        "label": "Crates",
        "group": "Operations",
        "description": "Returnable crate ledger, dispatch/receive, approvals and crate summaries."
      }
    ],
    "can_edit": true
  }
}
```

## PUT /workspace/features

Switch modules on or off. Partial: send only the keys to change. Unknown keys and non-boolean values are rejected with 400 rather than ignored. Sets source to admin and returns the full set, same shape as GET.

Access: API keys cannot call this endpoint; workspace administrators only.

**Request body**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `modules` | object | yes | { "crates": true, "wallet": false } |

**Example request**

```bash
curl -X PUT https://api.spirestock.com/api/v1/workspace/features \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "modules": { "crates": true, "wallet": false } }'
```

**Example response**

```json
{
  "response_code": 200,
  "message": "Features updated",
  "data": {
    "modules": {
      "crates": true,
      "logistics": true,
      "tracking": true,
      "hr": true,
      "field_sales": true,
      "accounts": true,
      "wallet": true,
      "credit_risk": true,
      "expenses": true,
      "incentives": true,
      "gamification": true,
      "batches": true,
      "returns": true,
      "foc": true,
      "sales_intelligence": true,
      "subscriptions": true,
      "scheduled_reports": true,
      "developer": true
    },
    "source": "admin",
    "decided_at": "2026-10-22T08:47:20.654Z",
    "core": [
      "dashboard",
      "orders",
      "customers"
    ],
    "catalogue": [
      {
        "key": "crates",
        "label": "Crates",
        "group": "Operations",
        "description": "Returnable crate ledger, dispatch/receive, approvals and crate summaries."
      }
    ],
    "can_edit": true
  }
}
```

## GET /dashboard/onboarding

The Get Started checklist for administrators: each step with done, the progress (completed, total, percent, complete), the workspace counts behind it, empty_workspace, and when the caller dismissed the checklist. Steps for switched-off modules are left out. Other callers get 403.

Access: API key `read` scope; workspace administrators only.

**Example request**

```bash
curl https://api.spirestock.com/api/v1/dashboard/onboarding \
  -H "X-API-Key: YOUR_API_KEY"
```

**Example response**

```json
{
  "response_code": 200,
  "data": {
    "steps": [
      {
        "key": "production_unit",
        "title": "Add your production unit",
        "description": "Plants or warehouses you dispatch from. Every order and report is split by unit.",
        "href": "/dashboard/masters?tab=production-units",
        "cta": "Review units",
        "optional": false,
        "done": true
      }
    ],
    "completed": 7,
    "total": 7,
    "percent": 100,
    "complete": true,
    "counts": {
      "production_units": 2,
      "products": 46,
      "priced_variants": 107,
      "rate_rows": 1,
      "customers": 10225,
      "team_members": 141,
      "pending_invites": 0,
      "orders": 1,
      "role_grants": 1,
      "device_tokens": 0,
      "api_keys": 0
    },
    "empty_workspace": false,
    "dismissed_at": null
  }
}
```

## GET /auth/me/onboarding

The caller's product-tour state: tour (completed_at, dismissed_at, remind_after, last_step, variant), checklist.dismissed_at, is_admin, and auto_show, which says whether the tour should open by itself on this page load. A finished or skipped tour never comes back; a snoozed one returns once remind_after has passed.

Access: API keys cannot call this endpoint; any staff user, for their own records.

**Example request**

```bash
curl https://api.spirestock.com/api/v1/auth/me/onboarding \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**Example response**

```json
{
  "response_code": 200,
  "data": {
    "tour": {
      "completed_at": null,
      "dismissed_at": null,
      "remind_after": null,
      "last_step": 3,
      "variant": "admin"
    },
    "checklist": {
      "dismissed_at": null
    },
    "is_admin": true,
    "auto_show": false
  }
}
```

## PUT /auth/me/onboarding

Record a tour or checklist action and get the new state back (same shape as GET). tour: complete, dismiss, snooze (returns after 3 days), progress (with step 0-50) or restart, optionally with variant admin or staff. checklist: dismiss or restore. Send at least one of tour or checklist.

Access: API keys cannot call this endpoint; any staff user, for their own records.

**Request body**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tour` | string | no | complete, dismiss, snooze, progress or restart |
| `step` | number | no | 0-50, required with tour=progress |
| `variant` | string | no | admin or staff |
| `checklist` | string | no | dismiss or restore |

**Example request**

```bash
curl -X PUT https://api.spirestock.com/api/v1/auth/me/onboarding \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "tour": "progress", "step": 3, "variant": "admin" }'
```

**Example response**

```json
{
  "response_code": 200,
  "data": {
    "tour": {
      "completed_at": null,
      "dismissed_at": null,
      "remind_after": null,
      "last_step": 3,
      "variant": "admin"
    },
    "checklist": {
      "dismissed_at": null
    },
    "is_admin": true,
    "auto_show": false
  }
}
```
