> ## Documentation Index
> Fetch the complete documentation index at: https://developers.nexspace365.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clear and re-seed a facility's sandbox data

> Wipe the `is_sandbox` rows for one facility and re-seed a fresh sandbox
dataset. Sandbox lives on this same host — a `nex_test_` key is isolated
by row-level filtering, not by a separate hostname.

**API keys are rejected — including `nex_test_` sandbox keys.** This
route sits behind `requireApiKeyMinter`, which refuses any request
carrying a `nex_…` token with `403 FORBIDDEN` before the handler runs.
Reset is a dashboard/session developer operation precisely so a
low-scope token cannot wipe data. The caller must be a super admin, or
an admin/manager in the platform-internal NexSpace 365 organization.

`facilityId` is caller-supplied, so it is checked against the caller's
own scope: super admins may target any facility, everyone else only
their own.




## OpenAPI

````yaml https://api.nexspace365.com/api/openapi.json post /api/sandbox/reset
openapi: 3.0.3
info:
  title: NexSpace 365 API
  description: >
    Multi-industry enterprise workforce management platform — scheduling, HR,

    payroll, CRM, AI, and messaging suites.


    ## Authentication

    Four credentials, all but the first sent as `Authorization: Bearer <token>`:

    session cookie, JWT bearer, API key (`nex_live_…` / `nex_test_…` /

    `nex_pat_…`), and OAuth 2.1 access token. AI agents should use an API key or

    an OAuth token with the appropriate scopes.


    ## Authorization

    Endpoints require specific permissions via the RBAC system:

    - **Internal team**: Full platform access

    - **Facility users**: Scoped to their org/facilities

    - **Staff**: Limited to own data


    ## Error Contract

    All errors return `{ error: { message, code?, suggestion?, retryable? },
    requestId? }`.

    The `suggestion` field hints at how to fix the request; `retryable` signals
    whether

    retry-with-backoff is appropriate.


    ## Versioning

    Pin your integration to a specific API version via the `NexSpace-Version`
    header

    (date-based, e.g. `2026-05-10`). When absent, the latest version is assumed.

    Deprecated versions include `Sunset` and `Deprecation` headers. Discovery at

    `GET /.well-known/api-versions`.


    ## Idempotency

    Write operations (POST/PUT/PATCH) accept an `Idempotency-Key` header. If

    the same key + body combination is sent again within 24 hours, the original

    response is replayed. Different body with the same key returns 409 Conflict.


    ## MCP (Model Context Protocol)

    AI agents interact via `POST /mcp` using JSON-RPC 2.0. Call `tools/list` to

    discover available verbs, then `tools/call` to invoke them.


    MCP is served on its own host — `https://mcp.nexspace365.com`, not the API

    host. `api.nexspace365.com` rejects `/mcp`, `/mcp/*` and `/.well-known/mcp`

    with `403 MCP_HOST_NOT_ALLOWED`, and those operations pin the correct host

    with an operation-level `servers` override. The

    `/.well-known/oauth-protected-resource*` operations are also tagged MCP but

    are **not** covered by the host guard — they answer on either host.
  version: 1.0.0
  contact:
    name: NexSpace
    email: admin@nexspace365.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.nexspace365.com
    description: Production server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Authentication
    description: User authentication and session management
  - name: Facilities
    description: Facility management
  - name: Staff
    description: Staff member management and profiles
  - name: Credentials
    description: Staff credential tracking — licenses, certifications, and training
  - name: Shifts
    description: Shift scheduling and management
  - name: Agents
    description: Headless agent runs, human-in-the-loop approvals, and automation triggers.
  - name: Dashboard
    description: Dashboard statistics and widgets
  - name: API Keys
    description: API key lifecycle — create, list, revoke, rotate
  - name: MCP
    description: Model Context Protocol endpoint for AI agent tool calling
  - name: OAuth
    description: OAuth 2.1 authorization server — DCR, authorize, token
  - name: Webhooks
    description: Outbound webhook subscription management
  - name: Analytics
    description: API usage analytics and observability
  - name: Sandbox
    description: Sandbox (`nex_test_`) data lifecycle for the same production host
  - name: Platform
    description: Version discovery and platform metadata.
paths:
  /api/sandbox/reset:
    post:
      tags:
        - Sandbox
      summary: Clear and re-seed a facility's sandbox data
      description: |
        Wipe the `is_sandbox` rows for one facility and re-seed a fresh sandbox
        dataset. Sandbox lives on this same host — a `nex_test_` key is isolated
        by row-level filtering, not by a separate hostname.

        **API keys are rejected — including `nex_test_` sandbox keys.** This
        route sits behind `requireApiKeyMinter`, which refuses any request
        carrying a `nex_…` token with `403 FORBIDDEN` before the handler runs.
        Reset is a dashboard/session developer operation precisely so a
        low-scope token cannot wipe data. The caller must be a super admin, or
        an admin/manager in the platform-internal NexSpace 365 organization.

        `facilityId` is caller-supplied, so it is checked against the caller's
        own scope: super admins may target any facility, everyone else only
        their own.
      operationId: resetSandbox
      parameters:
        - $ref: '#/components/parameters/NexSpaceVersionHeader'
        - $ref: '#/components/parameters/IdempotencyKeyHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - facilityId
              properties:
                facilityId:
                  type: integer
                  description: The sandbox facility to clear and re-seed.
              example:
                facilityId: 1
      responses:
        '200':
          description: Sandbox reset
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  cleared:
                    type: object
                    additionalProperties: true
                    description: Per-table counts of rows removed.
                  seeded:
                    type: object
                    additionalProperties: true
                    description: Per-table counts of rows created.
        '400':
          description: '`VALIDATION_FAILED` — `facilityId` missing or not a number.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: |
            `FORBIDDEN`, from one of:
            - the request was authenticated with an API key (any `nex_…` token,
              `nex_test_` included) — sign in to the dashboard instead;
            - the caller is not a super admin and not an admin/manager in the
              internal NexSpace 365 organization;
            - the requested `facilityId` is outside the caller's scope
              ("You do not have access to this facility").
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`NOT_FOUND` — no facility with that id.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - bearerAuth: []
components:
  parameters:
    NexSpaceVersionHeader:
      name: NexSpace-Version
      in: header
      required: false
      schema:
        type: string
        pattern: ^\d{4}-\d{2}-\d{2}$
      description: >
        Pin the request to a dated API version (e.g. `2026-05-10`). Applied by
        app-level middleware to every `/api` route (`server/routes/index.ts` →
        `apiVersionMiddleware`), which echoes the resolved value back in the
        `NexSpace-Version` response header. Omit to get the latest version.
        Discover the catalog at `GET /.well-known/api-versions`.
    IdempotencyKeyHeader:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: >
        Replay guard for write requests. Applied by app-level middleware to
        every `/api` route (`server/routes/index.ts` → `idempotencyMiddleware`),
        which only acts on POST/PUT/PATCH — GET, DELETE and OPTIONS ignore the
        header. Re-sending the same key with an identical body within 24 hours
        replays the original response; the same key with a different body
        returns `409`.
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: Human-readable error message
            code:
              type: string
              description: Machine-readable error code (e.g. VALIDATION_FAILED, NOT_FOUND)
            details:
              type: object
              description: Structured details (e.g. Zod validation issues)
            suggestion:
              type: string
              description: Hint for agents on how to recover
            retryable:
              type: boolean
              description: Whether the same request might succeed on retry
          required:
            - message
        requestId:
          type: string
          description: Correlation ID for logs and Sentry
      required:
        - error
  responses:
    RateLimited:
      description: >
        Per-key rate limit exceeded. Includes `Retry-After` and the full
        `X-RateLimit-*` set so agents can back off precisely (NEX-1659).
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              message: Rate limit exceeded for this API key
              code: API_KEY_RATE_LIMITED
              suggestion: >-
                Wait until X-RateLimit-Reset before retrying, or batch
                operations.
              retryable: true
  headers:
    Retry-After:
      description: Seconds to wait before retrying (present on 429).
      schema:
        type: integer
    X-RateLimit-Limit:
      description: Requests allowed per window for this API key (NEX-1659).
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the current window resets.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token authentication
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: NexSpaceApiKey
      description: |
        API key or personal access token (NEX-1042). Send as
        `Authorization: Bearer <token>`. Token format:
          - `nex_live_…`  — live API key (server-to-server)
          - `nex_test_…`  — sandbox API key
          - `nex_pat_…`   — personal access token (acts as the issuing user)

        Authorization is decided by the key's `scopes` array, not the
        owning user's RBAC role. See `POST /api/api-keys` to mint a key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.