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

# 获取邀请码

> 获取用于加入 workspace 的邀请码。

<ParamField header="Authorization" type="string" placeholder="API Key" required>
  你账户的 API 密钥。你可以在[账户设置](https://squarecloud.app/zh/account/security)中找到它。
</ParamField>

### 响应

<ResponseField name="status" type="string">
  指示调用是否成功。成功时为 `success`，否则为 `error`。
</ResponseField>

<ResponseField name="code" type="string">
  你的 workspace 邀请码。
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "status": "success",
    "code": "9c1a499e623d2410226f1ecdc7e6daaec2fc6704"
  }
  ```
</ResponseExample>