---
title: "Get workspace details"
method: GET
path: "/workspaces/{workspace_id}"
tags: ["workspaces"]
---

# Get workspace details

`GET /workspaces/{workspace_id}`

Returns a consolidated, read-only summary of a partner-managed workspace. The payload includes basic workspace identity (workspace_id, display_name), seat allocation and utilization, messaging and API quotas, any non-recurring quota balance, the list of users in the workspace, WhatsApp accounts associated with the workspace, and currently active QR-code links. Only workspaces that are owned by the calling partner and are not -billing managed are eligible. If the workspace does not exist or is not linked to the partner, a 404 error is returned.

## Path parameters

- `workspace_id` string, required

## Headers

- `X-TL-Partner-Id` string, required

## Response `200`

Workspace details

- PartnerAPIWorkspaceExtendedResponse — Detailed summary of a partner-managed workspace. Combines core workspace identity with seat usage, messaging and Public API quotas, non-recurring quota balances, the list of users, WhatsApp accounts associated with the workspace, and active QR links. Used by partners to monitor utilization and operational health of a workspace in a single call.
  - `workspace_id` string, required — Unique identifier for the workspace
  - `display_name` string, required — Workspace display name
  - `seats` PartnerAPIQuota, required — Workspace quota details
    - `total` integer, required — Total number of seats in the workspace
    - `used` integer, required — Number of used seats in the workspace
    - `period_start` string, date-time — Start date of the quota period
    - `period_end` string, date-time — End date of the quota period
  - `messages_quota` PartnerAPIQuota, required — Workspace quota details
    - `total` integer, required — Total number of seats in the workspace
    - `used` integer, required — Number of used seats in the workspace
    - `period_start` string, date-time — Start date of the quota period
    - `period_end` string, date-time — End date of the quota period
  - `api_calls_quota` PartnerAPIQuota, required — Workspace quota details
    - `total` integer, required — Total number of seats in the workspace
    - `used` integer, required — Number of used seats in the workspace
    - `period_start` string, date-time — Start date of the quota period
    - `period_end` string, date-time — End date of the quota period
  - `whatsapp_accounts` PartnerAPIWhatsappAccount[]
    - `user_id` integer — User ID associated with the WhatsApp account
    - `connected` boolean, required — Current status of the WhatsApp account
    - `whatsapp_account_id` integer, required — ID of the WhatsApp account
    - `phone_number_e164` string, required — Phone number associated with the WhatsApp account
    - `connection_status` string, required — Connection status of the WhatsApp account
    - `connected_at` string, date-time — Timestamp when the WhatsApp account was connected
  - `non_recurring_quota` PartnerAPINonRecurringQuota, required — Non-recurring quota information for a workspace. Represents an additional, non-recurring balance (for example, one-off purchased message packs) with the remaining_balance and the timestamp when it was last updated.
    - `remaining_balance` integer — Remaining balance of non-recurring quota
    - `last_updated_at` string, date-time — Timestamp of the last recharge
  - `users` PartnerAPIUser[], required
    - `user_id` integer, required — Unique identifier for the user
    - `display_name` string, required — Display name of the user
    - `role` string — Role of the user in the workspace
    - `email` string, required — Email address of the user
    - `status` string, required — Status of the user
    - `created_at` string, date-time, required — Timestamp of user creation
  - `qr_links` PartnerAPIQRCodeLink[]
    - `qr_link` string, required — QR code link for connecting to WhatsApp
    - `user_id` integer, required — ID of the user associated with the QR code link
    - `expires_at` string, date-time, required — Expiration timestamp of the QR code link

## Other responses

- `404` — Workspace not found

---

[API](https://skmtc.dev/initechsoftware/apis/partner-api.md) · [All operations](https://skmtc.dev/initechsoftware/apis/partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/initechsoftware/partner-api/revisions/f5ac60374320/schema)