> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Workspace

> Create a new workspace into your Square Cloud account.

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  The API key for your account. You can find this in your [account settings](https://squarecloud.app/en/account/security).
</ParamField>

Creates a workspace owned by the authenticated user, so applications can be shared with other Square Cloud accounts under a role-based permission model instead of transferring ownership. Workspaces are available on Standard, Pro, and Enterprise plans only; every plan tier in that range caps an account at 5 workspaces.

The `name` must be 1-32 characters (letters, numbers, spaces, hyphens, or underscores). After creating a workspace, use [Add Application](/en/api-reference/endpoint/workspace/apps/add) to share applications into it and [Invite Member](/en/api-reference/endpoint/workspace/members/invite) to add collaborators. This endpoint is rate limited to 1 creation every 10 seconds per user.

### Parameters

<ParamField body="name" type="string" placeholder="Workspace name">
  A string representing the name of the workspace. <br />Must adhere to the a to z, A to Z, 0 to 9, spaces and \_ pattern. (1-32 characters)
</ParamField>

### Response

<ResponseField name="status" type="string">
  Indicates whether the call was successful.. `success` if successful, `error` if not.
</ResponseField>

<ResponseField name="response" type="object">
  The contents of the response.

  <Expandable title="Toggle object">
    <ResponseField name="id" type="string">
      The ID of the Workspace.
    </ResponseField>

    <ResponseField name="name" type="string">
      The name of the Workspace.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}

  {
      "status": "success",
      "response": {
          "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
          "name": "Test"
      }
  }

  ```
</ResponseExample>

### Common errors

| Code                        | HTTP | Meaning                                                          |
| --------------------------- | ---- | ---------------------------------------------------------------- |
| `INVALID_NAME`              | 400  | `name` is missing or fails the 1-32 character pattern.           |
| `UPGRADE_REQUIRED`          | 403  | The active plan is not Standard, Pro, or Enterprise.             |
| `WORKSPACE_LIMIT_REACHED`   | 400  | The account already has the plan's maximum number of workspaces. |
| `WORKSPACE_CREATION_FAILED` | 400  | The workspace could not be created.                              |