---
updatedAt: 2026-07-10T09:54:26.000Z
agentTools:
  projectIndex: https://developers.rebrandly.com/llms.txt
---

# List Workspaces

List workspaces the authenticated user has access to.


# OpenAPI definition

````json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Rebrandly API",
    "description": "# Rebrandly API Documentation\n\nThe Rebrandly API allows you to programmatically create, update, and manage your branded short links,\ncustom domains, workspaces, and analytics.\n\n## Base URL\n\nAll API requests should be made to:\n```\nhttps://api.rebrandly.com/v1\n```\n\n## Authentication\n\nThe Rebrandly API uses API keys for authentication. You can obtain your API key from your\n[Rebrandly account settings](https://app.rebrandly.com/account/api-keys).\n\nInclude your API key in the request header:\n```\napikey: YOUR_API_KEY\n```\n\n## Rate Limiting\n\nAPI requests are rate-limited based on your subscription plan. Rate limit information is included\nin response headers:\n- `X-RateLimit-Limit`: Total requests allowed per period\n- `X-RateLimit-Remaining`: Requests remaining in current period\n- `X-RateLimit-Reset`: Time when the rate limit resets (Unix timestamp)\n\n## Multi-Tenancy and Workspaces\n\nMost Rebrandly API resources (links, domains, scripts, tags) are organized into **Workspaces**.\nTo access resources in a specific workspace, you must include the `Workspace` header with the workspace's unique ID.\n\n```\nWorkspace: YOUR_WORKSPACE_ID\n```\n\nIf the `Workspace` header is omitted, the request will be processed in your **Default Workspace**.\n",
    "version": "7.0.2",
    "contact": {
      "name": "Rebrandly Team",
      "email": "dev@rebrandly.com"
    },
    "license": {
      "name": "Proprietary"
    }
  },
  "servers": [
    {
      "url": "https://api.rebrandly.com/v1",
      "description": "Production API"
    }
  ],
  "paths": {
    "/workspaces": {
      "get": {
        "summary": "List Workspaces",
        "description": "List workspaces the authenticated user has access to.\n",
        "operationId": "getSharedWorkspaces",
        "parameters": [
          {
            "name": "orderBy",
            "in": "query",
            "description": "Sorting criteria",
            "schema": {
              "type": "string",
              "enum": [
                "name",
                "createdAt"
              ],
              "default": "createdAt"
            }
          },
          {
            "name": "orderDir",
            "in": "query",
            "description": "Sorting direction",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ],
              "default": "desc"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Pagination offset",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Pagination limit",
            "schema": {
              "type": "integer",
              "default": 25
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A list of workspaces",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Unique identifier of the workspace"
                      },
                      "name": {
                        "type": "string",
                        "description": "Name of the workspace"
                      },
                      "default": {
                        "type": "boolean",
                        "description": "Whether this is the default (main) workspace"
                      },
                      "type": {
                        "type": "string",
                        "description": "Type of workspace"
                      },
                      "createdAt": {
                        "type": "string",
                        "format": "date-time",
                        "description": "UTC creation date/time of the workspace"
                      },
                      "owner": {
                        "type": "object",
                        "description": "Workspace owner details",
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Unique identifier of the owner"
                          },
                          "username": {
                            "type": "string",
                            "description": "Username of the owner"
                          }
                        }
                      },
                      "role": {
                        "type": "string",
                        "description": "The authenticated user's role in this workspace",
                        "enum": [
                          "owner",
                          "manager",
                          "guest"
                        ]
                      },
                      "subscription": {
                        "type": "object",
                        "description": "Subscription information derived from the workspace owner's plan",
                        "properties": {
                          "category": {
                            "type": "string",
                            "description": "The subscription plan category of the workspace owner (e.g. free, growth, enterprise)"
                          },
                          "limits": {
                            "type": "object",
                            "description": "Resource usage and limits for the workspace owner's account",
                            "properties": {
                              "domains": {
                                "type": "object",
                                "properties": {
                                  "used": {
                                    "type": "integer",
                                    "description": "Number of domains used"
                                  },
                                  "included": {
                                    "type": "integer",
                                    "description": "Number of domains included in the plan"
                                  }
                                }
                              }
                            }
                          },
                          "billing": {
                            "type": "object",
                            "description": "Billing information",
                            "properties": {
                              "extra": {
                                "type": "object",
                                "description": "Extra billing details"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "apikey",
        "description": "Rebrandly API key for authentication"
      }
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "x-readme": {}
}
````