> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pivolio.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pivolio.com/_mcp/server.

# List your workspaces

GET /workspaces

Lists every workspace you belong to, each annotated with your role in it.

Reference: https://docs.pivolio.com/api-reference/pivolio/workspaces/list-workspaces

## Response

### 200

Successful Response

- `list of WorkspaceResponse`

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `detail` (string, required)
- `code` (string, required)
- `errors` (list of FieldError, optional, nullable)

## Types

### WorkspaceResponse

- `id` (string, required)
- `name` (string, required)
- `slug` (string, required)
- `timezone` (string, required)
- `role` (enum, required) — A member's role on an Account (the tenant above workspaces). Grants access to ALL of the account's workspaces; the role varies the permission level, not which workspaces (see agency design §4). Phase 0 assigns only OWNER; the rest exist for the later agency phase.
  - Allowed values: `owner`, `admin`, `billing`, `member`
- `created_at` (datetime, required)
- `website_url` (string, optional, nullable)

### FieldError

- `field` (string, required)
- `message` (string, required)

## Examples

**Response**

```json
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Acme Marketing",
    "slug": "acme-marketing",
    "timezone": "America/New_York",
    "role": "owner",
    "created_at": "2024-01-15T09:30:00Z",
    "website_url": "https://www.acmemarketing.com"
  },
  {
    "id": "7b9c9f1e-2d3a-4f8a-9b6e-1a2b3c4d5e6f",
    "name": "Beta Analytics",
    "slug": "beta-analytics",
    "timezone": "Europe/London",
    "role": "admin",
    "created_at": "2023-11-20T14:45:00Z",
    "website_url": "https://www.betaanalytics.io"
  },
  {
    "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
    "name": "Gamma Solutions",
    "slug": "gamma-solutions",
    "timezone": "Asia/Tokyo",
    "role": "viewer",
    "created_at": "2024-03-01T08:00:00Z",
    "website_url": null
  }
]
```

**SDK Code**

```python
import requests

url = "https://api.example.com/workspaces"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.example.com/workspaces';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workspaces"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.example.com/workspaces")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/workspaces');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/workspaces");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/workspaces")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```