---
updatedAt: 2026-06-21T19:39:10.000Z
agentTools:
  projectIndex: https://developers.rebrandly.com/llms.txt
---

# List Workspaces

Get all workspaces you either own or participate into as a member

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Rebrandly Legacy",
    "description": "Transform your long URLs into short branded links",
    "termsOfService": "https://rebrandly.com/terms-conditions",
    "version": "1.0.0",
    "contact": {
      "url": "https://developers.rebrandly.com"
    }
  },
  "servers": [
    {
      "url": "https://api.rebrandly.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "viaApikey": {
        "type": "apiKey",
        "in": "header",
        "name": "apikey"
      }
    }
  },
  "security": [
    {
      "viaApikey": []
    }
  ],
  "paths": {
    "/v1/workspaces": {
      "get": {
        "summary": "List Workspaces",
        "description": "Get all workspaces you either own or participate into as a member",
        "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"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "samples-enabled": true
  }
}
```