LOlovable
workspaces

Get workspace

Changed on

Plan: Business or higher

Scope: workspaces:read

Returns workspace details, security and publishing policies, seat count, billing period, and default member credit limit. Usage fields are null without permission to view workspace usage. Member details, including roles, are on GET /v1/workspaces/{workspace_id}/members. The num_projects count is eventually consistent and may not immediately reflect project creation or deletion.

get/v1/workspaces/{workspace_id}

Request

  • Base URL
    https://api.lovable.dev
  • Auth
    • API key in header Lovable-API-Key
    • or HTTP bearer

Path parameters

workspace_idstring required

Workspace ID.

Example:workspace_01jw3k9m2xq8r5v0c7d4e6f2gh

Headers

Lovable-Versionstring

Stable API version to serve, as a YYYY-MM-DD date. Omit for the oldest supported stable version, currently 2026-09-11.

Lovable-Betastring

Comma-separated beta revision strings to enable on top of the stable version.

Response

OK

billing_period_ends_atstring date-time nullable required

Exclusive end of the current billing period. Null when no billing period is recorded or when the caller lacks permission to view workspace usage.

billing_period_starts_atstring date-time nullable required

Inclusive start of the current billing period. Null when no billing period is recorded or when the caller lacks permission to view workspace usage.

created_atstring date-time required

When the workspace was created.

default_monthly_member_credit_limitnumber double nullable required

Default monthly build-credit limit for members without an explicit per-member limit. Null when unset or when the caller lacks permission to view workspace usage. Active higher temporary limits can override it.

default_project_visibility'restricted' | 'workspace_edit' | 'workspace_view' | 'null' nullable required

Default editor visibility for new projects, separate from published app access. workspace_edit: every workspace member, at the access level their workspace role grants. restricted: only the project owner, invited collaborators, and the workspace owner; requires Business or Enterprise, otherwise new projects fall back to workspace_edit. Null when no default is configured. More values may be added; clients must tolerate unknown values.

descriptionstring nullable required

Workspace description; null when none is set.

enable_piiboolean required

Whether scanning for personally identifiable information (PII), such as names and email addresses, is enabled for workspace projects.

enforce_ssoboolean required

Whether workspace members are required to sign in through single sign-on (SSO).

idstring required

Workspace ID.

image_urlstring nullable required

Workspace image URL; null when none is set.

namestring required

Workspace display name.

num_projectsinteger required

Number of projects in the workspace.

num_seatsinteger nullable required

Configured maximum number of workspace seats. Null when no positive workspace-specific seat limit is configured or when the caller lacks permission to view workspace usage.

plan'free' | 'pro' | 'business' | 'enterprise' required

Plan tier. More values may be added; clients must tolerate unknown values.

publishing_policy'org_only' | 'workspace_only' | 'disabled' | 'null' nullable required

Policy limiting who can view published apps or preventing publishing altogether; null when no audience restriction is configured. More values may be added; clients must tolerate unknown values.

updated_atstring date-time required

When the workspace was last updated.

Example response

{
  "billing_period_ends_at": "2026-02-01T00:00:00Z",
  "billing_period_starts_at": "2026-01-01T00:00:00Z",
  "created_at": "2026-01-15T09:30:00Z",
  "default_monthly_member_credit_limit": 500,
  "default_project_visibility": "workspace_edit",
  "description": "Marketing site and internal tools for Acme.",
  "enable_pii": true,
  "enforce_sso": true,
  "id": "workspace_01jw3k9m2xq8r5v0c7d4e6f2gh",
  "image_url": "https://lovable.dev/cdn/workspaces/acme/avatar.png",
  "name": "Acme Inc",
  "num_projects": 12,
  "num_seats": 25,
  "plan": "pro",
  "publishing_policy": "workspace_only",
  "updated_at": "2026-01-15T09:30:00Z"
}

Changes

  • a83f0776a896Revision changes
    • info

      for the header request parameter Lovable-Version, the format was generalized from date to no format

    • info

      added the non-success response with the status

  • 63e95b862209Revision changes
    • info

      added the non-success 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status