---
title: "List Workspaces For Organization"
method: GET
path: "/workspaces"
tags: ["Workspaces"]
---

# List Workspaces For Organization

`GET /workspaces`

## Request

- Base URL: `https://api-external.zenlytic.com/api/v2`
- URL: `https://api-external.zenlytic.com/api/v2/workspaces`
- Auth: HTTP bearer

List the workspaces in your organization.

Archived workspaces are excluded unless ``include_archived`` is true.

## Query parameters

- `include_archived` boolean: Include archived workspaces in the results.

## Response `200`

Successful Response

- ApiV2CollectionResponseWorkspaceSchema
  - `data` WorkspaceSchema[], required
    - `id` string, required
    - `name` string, required
    - `provision_by_default` boolean, required: When true, new users signing in via SSO are automatically granted access to this workspace; when false, they need an explicit invite.
    - `archived_at` string, date-time, nullable: When this workspace was archived; null while active.
  - `meta` MetaSchema, required
    - `status` 'success' | 'error', required
    - `errors` ErrorSchema[]: Non-empty exactly when `status` is "error".
      - `message` string, required
      - `status_code` integer, nullable: Matches this response's actual HTTP status code.
      - `occurred_at` string, nullable: ISO 8601 UTC timestamp.
      - `error_code` string, nullable: Machine-readable code for errors that need special handling (e.g. "SSO_REQUIRED") rather than being shown generically; null for most errors.
      - `error_metadata` BaseErrorMetadata
    - `warnings` WarningSchema[]: Can be non-empty even when `status` is "success" - a non-fatal issue with an otherwise-successful request.
      - `message` string, required
    - `request_source` string, nullable: Which auth mechanism served this request (e.g. "api_key", "pat"); null when not tracked for this endpoint.

## Other responses

- `4XX`: Client Error
- `5XX`: Server Error

---

[API](https://skmtc.dev/zenlytic/apis/zenlytic-api.md) - [All operations](https://skmtc.dev/zenlytic/apis/zenlytic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zenlytic/apis/zenlytic-api/revisions/8963663e2b8f?raw)