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

# List Workspaces

> List your workspaces.

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

### 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="owner" type="string">
      The Workspace owner id.
    </ResponseField>

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

    <ResponseField name="members" type="object">
      The workspace member list.

      <Expandable title="Toggle object">
        <ResponseField name="id" type="string">
          The user's ID.
        </ResponseField>

        <ResponseField name="name" type="string">
          The user's name.
        </ResponseField>

        <ResponseField name="group" type="string">
          The member permissions on the workspace applications.
        </ResponseField>

        <ResponseField name="joinedAt" type="string">
          The join timestamp in UTC-0.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="applications" type="object">
      The workspace applications list.

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

        <ResponseField name="name" type="string">
          The name of the uploaded application.
        </ResponseField>

        <ResponseField name="ram" type="number">
          The RAM usage of the uploaded application in MB.
        </ResponseField>

        <ResponseField name="language" type="object">
          The programming language of the uploaded application.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      The creation timestamp in UTC-0.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
      "status": "success",
      "response": [
          {
              "id": "dcedcd13d7e272a7b32a70f6a1d180f23c12d759",
              "name": "Test",
              "owner": "5354d9742d889d49b20134ba0be09ccc0033be68",
              "members": [
              {
                  "name": "Example",
                  "id": "5354d9742d889d49b20134ba0be09ccc0033be68",
                  "group": "owner",
                  "joinedAt": "2025-06-04T20:44:55.934Z"
              }
              ],
              "applications": [],
              "createdAt": "2025-06-04T20:44:55.934Z"
          }
      ]
  }
  ```
</ResponseExample>