> 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.

# Create a workspace

POST /workspaces
Content-Type: multipart/form-data

Creates a workspace, adds you as its owner, and provisions an initial write key.

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

## Request

### Body (multipart/form-data)

This endpoint expects a multipart form.

- `name` (string, required)
- `website_url` (string, required)
- `slug` (string, optional)
- `timezone` (string, optional)

## Response

### 201

Successful Response

- `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)

## Errors

### 422 Unprocessable Entity Error

Validation Error

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

## Types

### FieldError

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

## Examples

**Request**

```json
{
  "name": "Acme Analytics",
  "website_url": "https://www.acmeanalytics.com"
}
```

**Response**

```json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Acme Analytics",
  "slug": "acme-analytics",
  "timezone": "UTC",
  "role": "owner",
  "created_at": "2024-01-15T09:30:00Z",
  "website_url": "https://www.acmeanalytics.com"
}
```

**SDK Code**

```python
import requests

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

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nAcme Analytics\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"website_url\"\r\n\r\nhttps://www.acmeanalytics.com\r\n-----011000010111000001101001--\r\n"
headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}

response = requests.post(url, data=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.example.com/workspaces';
const form = new FormData();
form.append('name', 'Acme Analytics');
form.append('slug', '');
form.append('timezone', '');
form.append('website_url', 'https://www.acmeanalytics.com');

const options = {method: 'POST'};

options.body = form;

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nAcme Analytics\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"website_url\"\r\n\r\nhttps://www.acmeanalytics.com\r\n-----011000010111000001101001--\r\n")

	req, _ := http.NewRequest("POST", url, payload)

	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::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nAcme Analytics\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"website_url\"\r\n\r\nhttps://www.acmeanalytics.com\r\n-----011000010111000001101001--\r\n"

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.post("https://api.example.com/workspaces")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nAcme Analytics\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"website_url\"\r\n\r\nhttps://www.acmeanalytics.com\r\n-----011000010111000001101001--\r\n")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.example.com/workspaces', [
  'multipart' => [
    [
        'name' => 'name',
        'contents' => 'Acme Analytics'
    ],
    [
        'name' => 'website_url',
        'contents' => 'https://www.acmeanalytics.com'
    ]
  ]
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/workspaces");
var request = new RestRequest(Method.POST);
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\nAcme Analytics\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"slug\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"timezone\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"website_url\"\r\n\r\nhttps://www.acmeanalytics.com\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation
let parameters = [
  [
    "name": "name",
    "value": "Acme Analytics"
  ],
  [
    "name": "slug",
    "value": 
  ],
  [
    "name": "timezone",
    "value": 
  ],
  [
    "name": "website_url",
    "value": "https://www.acmeanalytics.com"
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

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

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()
```