---
title: "List accessible workspaces"
method: GET
path: "/api/workspaces"
tags: ["workspaces"]
---

# List accessible workspaces

`GET /api/workspaces`

## Request

- Base URL: `https://rstream.io`
- URL: `https://rstream.io/api/workspaces`
- Auth: HTTP bearer

## Query parameters

- `type` 'personal' | 'organization'
- `membershipStatus` 'active' | 'invited'

## Response `200`

Successful response.

- ListWorkspacesResponse
  - `workspaces` union[], required
    - union
      - object
        - `id` string, required
        - `type` 'personal', required
        - `name` string, required
        - `membership` object, required
          - `role` 'owner' | 'admin' | 'member' | 'viewer', required
          - `status` 'active' | 'invited', required
          - `invitedAt` string, date-time
          - `joinedAt` string, date-time
        - `subscriptionStatus` 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid'
        - `hasPaymentMethod` boolean
        - `hasBasicTier` boolean
        - `enterprise` object
          - `status` 'active' | 'suspended' | 'disabled', required
          - `projectCreationMode` 'enterprise_projects', required
          - `workspaceKeyMode` 'disabled' | 'optional' | 'required', required
      - object
        - `id` string, required
        - `type` 'organization', required
        - `name` string, required
        - `membership` object, required
          - `role` 'owner' | 'admin' | 'member' | 'viewer', required
          - `status` 'active' | 'invited', required
          - `invitedAt` string, date-time
          - `joinedAt` string, date-time
        - `subscriptionStatus` 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid'
        - `hasPaymentMethod` boolean
        - `hasBasicTier` boolean
        - `enterprise` object
          - `status` 'active' | 'suspended' | 'disabled', required
          - `projectCreationMode` 'enterprise_projects', required
          - `workspaceKeyMode` 'disabled' | 'optional' | 'required', required

## Other responses

- `400`: Request validation failed.
- `401`: Authentication is required.
- `403`: The token is not authorized.

---

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