> For the complete documentation index, see [llms.txt](https://docs.flashback.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flashback.tech/support-reference/platform-api-reference/workspace.md).

# Workspace

This file outlines the Flashgate API's workspace management features, including creating, updating, listing, and managing workspaces that group users and resources within an organization. Workspaces support role-based access control with READ, WRITE, and ADMIN permissions.

{% hint style="info" %}
To perform these operations, you must be authenticated by means of one of the following methods: [BearerAuth](/support-reference/platform-api-reference.md#http-bearer-authentication).
{% endhint %}

## Workspace API Calls <a href="#flashgate-api-workspaces" id="flashgate-api-workspaces"></a>

| Method                                                                   | API Reference                                                                                                                                   | Description                                                       |
| ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| <mark style="color:orange;">`POST`</mark>`/workspace`                    | [**post\_\_workspace**](/support-reference/platform-api-reference/workspace/post__workspace.md)                                                 | Create a new workspace for the authenticated user's organization. |
| <mark style="color:green;">`GET`</mark>`/workspace`                      | [**get\_\_workspace**](/support-reference/platform-api-reference/workspace/get__workspace.md)                                                   | Retrieve all workspaces the authenticated user can access.        |
| <mark style="color:green;">`GET`</mark>`/workspace/{id}`                 | [**get\_\_workspace\_workspaceid**](/support-reference/platform-api-reference/workspace/get__workspace_-workspaceid.md)                         | Retrieve a specific workspace by ID.                              |
| <mark style="color:purple;">`PUT`</mark>`/workspace/{id}`                | [**put\_\_workspace\_workspaceid**](/support-reference/platform-api-reference/workspace/put__workspace_-workspaceid.md)                         | Update an existing workspace's configuration.                     |
| <mark style="color:red;">`DELETE`</mark>`/workspace/{id}`                | [**delete\_\_workspace\_workspaceid**](/support-reference/platform-api-reference/workspace/delete__workspace_-workspaceid.md)                   | Delete a workspace (soft delete).                                 |
| <mark style="color:orange;">`POST`</mark>`/workspace/{id}/users`         | [**post\_\_workspace\_wksid\_users**](/support-reference/platform-api-reference/workspace/post__workspace_-wksid-_users.md)                     | Add a user to a workspace with specified role.                    |
| <mark style="color:purple;">`PUT`</mark>`/workspace/{id}/users/{userId}` | [**put\_\_workspace\_wksid\_users\_userid**](/support-reference/platform-api-reference/workspace/put__workspace_-wksid-_users_-userid.md)       | Update a user's role in a workspace.                              |
| <mark style="color:red;">`DELETE`</mark>`/workspace/{id}/users/{userId}` | [**delete\_\_workspace\_wksid\_users\_userid**](/support-reference/platform-api-reference/workspace/delete__workspace_-wksid-_users_-userid.md) | Remove a user from a workspace.                                   |

## Workspace Access Types

| Access Type | Description                                          |
| ----------- | ---------------------------------------------------- |
| `READ`      | Read-only access to workspace resources              |
| `WRITE`     | Read and write access to workspace resources         |
| `ADMIN`     | Full administrative access including user management |

## Workspace Management Permissions

* **Organization Owners, Administrators, and Workspace Managers** can create new workspaces
* **Workspace Admins** can manage workspace users and update workspace settings
* **Workspace Admins** can delete workspaces (only if they contain no buckets or repositories)
* Users must have validated accounts to perform workspace operations


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flashback.tech/support-reference/platform-api-reference/workspace.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.