Workspaces

✨ List workspaces

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> List all workspaces for your organization. Workspaces in Label Studio let you organize your projects and users into separate spaces. This is useful for managing different teams, departments, or projects within your organization. For more information, see the [Workspaces documentation](https://docs.humansignal.com/workspaces).
get/api/workspaces/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/workspaces/
  • Auth
    API key in header Authorization

Query parameters

include_all_workspacesboolean

Include all workspaces in the organization, including other users' personal workspaces. Only effective for users with Administrator or Owner role. When enabled, the response includes created_by_user info for personal workspaces.

is_archivedboolean

Filter by archived status. Set to false to exclude archived workspaces.

is_personalboolean

Workspace is a personal user workspace.

orderingstring

Which field to use when ordering the results.

Response

colorstring nullable

Color

created_byinteger required
created_by_userobject nullable required

Return created_by user details when include_all_workspaces is enabled.

descriptionstring nullable

Workspace description

idinteger required
interfaces_countinteger nullable required

Saved interfaces in the workspace. A workspace with interfaces cannot be deleted.

is_archivedboolean

Workspace is archived

is_personalboolean

Workspace is a personal user workspace

membershipobject nullable required
projects_countinteger nullable required
titlestring required

Workspace Name

Changes

  • 04dae10dc373Revision changes
    • info

      added the required property / to the response with the status

  • b5f055b9d45bRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from string to object for status

    • breaking

      the / response's property type changed from string to object for status