---
title: "List Workspaces"
method: GET
path: "/workspaces"
---

# List Workspaces

`GET /workspaces`

## Request

- Base URL: `https://api.rebrandly.com/v1`
- URL: `https://api.rebrandly.com/v1/workspaces`
- Auth: API key in header `apikey`

List workspaces the authenticated user has access to.

## Query parameters

- `orderBy` 'name' | 'createdAt'
- `orderDir` 'asc' | 'desc'
- `offset` integer
- `limit` integer

## Response `200`

A list of workspaces

- object[]
  - `id` string: Unique identifier of the workspace
  - `name` string: Name of the workspace
  - `default` boolean: Whether this is the default (main) workspace
  - `type` string: Type of workspace
  - `createdAt` string, date-time: UTC creation date/time of the workspace
  - `owner` object: Workspace owner details
    - `id` string: Unique identifier of the owner
    - `username` string: Username of the owner
  - `role` 'owner' | 'manager' | 'guest': The authenticated user's role in this workspace
  - `subscription` object: Subscription information derived from the workspace owner's plan
    - `category` string: The subscription plan category of the workspace owner (e.g. free, growth, enterprise)
    - `limits` object: Resource usage and limits for the workspace owner's account
      - `domains` object
        - `used` integer: Number of domains used
        - `included` integer: Number of domains included in the plan
    - `billing` object: Billing information
      - `extra` object: Extra billing details

---

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