---
title: "Inspect the current logical workspace and module states"
method: GET
path: "/workspaces/current"
tags: ["Organizations"]
---

# Inspect the current logical workspace and module states

`GET /workspaces/current`

## Request

- Base URL: `https://platform-api.homejourney.sg/v1`
- URL: `https://platform-api.homejourney.sg/v1/workspaces/current`
- Auth: HTTP bearer

Returns the logical workspace, exact environment incarnation, and safe module activation states bound to the authenticated API key organization. External URL: `/v1/workspaces/current`. Current Next.js implementation path: `/api/platform/v1/workspaces/current`. This route never infers another workspace from names, slugs, or row order.

## Headers

- `X-Correlation-Id` string

## Response `200`

Current logical workspace, incarnation, and module status.

- CurrentWorkspaceResponse
  - `workspace` object, required
    - `id` string, uuid, required
    - `display_name` string, required
    - `organization_type` string, required
    - `status` 'active' | 'suspended' | 'archived', required
  - `organization_incarnation` object, required
    - `id` string, uuid, required
    - `slug` string, required
    - `environment` 'sandbox' | 'live', required
    - `status` string, required
  - `modules` object[], required
    - `id` string, uuid, required
    - `module_key` string, required
    - `status` 'requested' | 'restricted' | 'approved' | 'active' | 'suspended' | 'revoked', required
    - `terms_version` string, nullable, required
  - `livemode` boolean, required
  - `request_id` string, required

## Other responses

- `400`: Request validation failed.
- `401`: Missing or invalid platform API key.
- `403`: Credential, environment, or scope is not allowed.
- `429`: Rate limit exceeded.
- `500`: Unexpected platform API failure.

---

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