MImistral
beta.admin.workspaces

Get Workspaces

Changed on

List Workspaces in the Organization.

get/v1/admin/workspaces

Request

Query parameters

is_archivedboolean

Whether to include archived Workspaces.

pageinteger

Page number to return.

page_sizeinteger

Maximum number of results per page.

searchstring nullable

Search term to filter Workspaces by name.

Example:Product

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": "★",
      "groups_count": 3,
      "spend_limit": {
        "currency": "USD"
      }
    }
  ]
}

Changes