Workspaces

Get workspace

Get details for a single workspace including Creative Units balance.

get/v1/workspaces/{workspace_id}

Request

Base URL: https://api.app.layer.ai/api
URL: https://api.app.layer.ai/api/v1/workspaces/{workspace_id}
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://auth.app.layer.ai/authorize, token URL https://auth.app.layer.ai/oauth/token)
- OAuth 2 (client credentials, token URL https://api.app.layer.ai/api/oauth/token, scopes: workspace:read)

workspace_idstring uuid required

Id of the workspace that owns the resource.

Successful Response

workspace_idstring uuid required

The workspace's unique identifier.

slugstring required

The workspace slug (its representation in the app URL).

namestring required

The workspace display name.

balance_creative_unitsnumber required

Total Creative Units balance before reservations.

reserved_creative_unitsnumber required

Creative Units reserved by in-progress generations.

available_creative_unitsnumber required

Usable balance (balance minus reserved). Can be negative.

last_active_atstring date-time nullable required

When the current user was last active in this workspace.

Oct 20, 2026326f3bcdabcc Revision changes
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Oct 11, 20262d86d473cda6 Revision changes
- info
  the endpoint scheme security serviceAccount was added to the API
- info
  the security scope workspace:read was removed from the endpoint's security scheme oauth2