List Workspaces

GET

workspaces

List Workspaces

curl --request GET \
  --url https://api.squarecloud.app/v2/workspaces \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": [
        {
            "id": "3f9c2a7e5b1d4e8a9c6f0b2d4e6a8c1f",
            "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"
        }
    ]
}

string

required

The API key for your account. You can find this in your account settings.

Requires an API key with the workspaces:manage scope. Returns every workspace where the authenticated user is either the owner or a member, each hydrated with its member list (names and roles) and its shared applications (name, RAM, language, domain). This is the entry point for building a workspace switcher or dashboard, since it avoids one Get Workspace call per workspace. The response is an empty array for a user with no workspaces, whether that’s because they’re on a plan without workspace access or simply haven’t created or joined one. To create the first one, see Create Workspace.

Response

string

Indicates whether the call was successful: success if it was, error if not.

object

The contents of the response.

Show Toggle object

string

The ID of the workspace: 32 hexadecimal characters (a UUID v4 without hyphens). Older workspaces have a 40-character hexadecimal ID.

string

The Workspace owner id.

string

The name of the Workspace.

object

The workspace member list. It always includes the owner, with group: "owner".

Show Toggle object

string

The user’s ID.

string

The user’s name. Can be null, for example when the account was deleted.

string

The member permissions on the workspace applications.

string

The join timestamp in UTC-0.

object

The workspace applications list.

Show Toggle object

string

The ID of the uploaded application.

string

The name of the uploaded application.

number

The RAM usage of the uploaded application in MB.

object

The programming language of the uploaded application.

string

The creation timestamp in UTC-0.

{
    "status": "success",
    "response": [
        {
            "id": "3f9c2a7e5b1d4e8a9c6f0b2d4e6a8c1f",
            "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"
        }
    ]
}

Common errors

Code	HTTP	Meaning
`DATABASE_UNAVAILABLE`	503	The service is briefly unavailable. Retry in a few seconds.

CLI: squarecloud workspace list
SDKs: api.workspaces.list() (JavaScript), client.workspaces.list() (Python), c.Workspaces.List() (Go)

List Workspaces

curl --request GET \
  --url https://api.squarecloud.app/v2/workspaces \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/workspaces"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": [
        {
            "id": "3f9c2a7e5b1d4e8a9c6f0b2d4e6a8c1f",
            "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"
        }
    ]
}

Get started

Account

Applications

Databases

Workspaces

AI

Response

Common errors

​Response

​Common errors

​Related

Response

Common errors

Related