Sign in

v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
beta.admin.workspaces

Get Workspaces

List Workspaces in the Organization.

get/v1/admin/workspaces

Query parameters

is_archivedboolean

Whether to include archived Workspaces.

Whether to include archived Workspaces.

pageinteger

Page number to return.

Page number to return.

page_sizeinteger

Maximum number of results per page.

Maximum number of results per page.

searchstring nullable

Search term to filter Workspaces by name.

Example:Product

Search term to filter Workspaces by name.

Response

OK

totalinteger required

Total number of Workspaces that match the request.

object'list'

Type of API object for pagination responses.

pageinteger required

Page number returned.

page_sizeinteger required

Maximum number of results per page.

Example response

{
  "items": [
    {
      "name": "Product Team",
      "description": "Workspace for product and design teams",
      "icon": "★",
      "spend_limit": {
        "currency": "USD"
      }
    }
  ]
}