Workspaces auflisten

GET

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

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope workspaces:manage. Gibt alle Workspaces zurück, bei denen der authentifizierte Benutzer entweder Eigentümer oder Mitglied ist, jeweils angereichert mit der Mitgliederliste (Namen und Rollen) und den geteilten Anwendungen (Name, RAM, Sprache, Domain). Dies ist der Einstiegspunkt für einen Workspace-Umschalter oder ein Dashboard, da so nicht pro Workspace ein separater Aufruf von Workspace abrufen nötig ist. Die Antwort ist ein leeres Array für einen Benutzer ohne Workspaces, unabhängig davon, ob das an einem Plan ohne Workspace-Zugriff liegt oder er schlicht noch keinen Workspace erstellt oder keinem beigetreten ist. Um den ersten zu erstellen, siehe Workspace erstellen.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Der Inhalt der Response.

Anzeigen Objekt umschalten

string

Die ID des Workspace: 32 hexadezimale Zeichen (eine UUID v4 ohne Bindestriche). Ältere Workspaces haben eine 40-stellige hexadezimale ID.

string

Die Owner-ID des Workspace.

string

Der Name des Workspace.

object

Die Mitgliederliste des Workspace. Sie enthält immer den Eigentümer, mit group: "owner".

Anzeigen Objekt umschalten

string

Die ID des Benutzers.

string

Der Name des Benutzers. Kann null sein, zum Beispiel wenn das Konto gelöscht wurde.

string

Die Berechtigungen des Mitglieds für die Anwendungen des Workspace.

string

Der Beitrittszeitstempel in UTC-0.

object

Die Anwendungsliste des Workspace.

Anzeigen Objekt umschalten

string

Die ID der hochgeladenen Anwendung.

string

Der Name der hochgeladenen Anwendung.

number

Der RAM-Verbrauch der hochgeladenen Anwendung in MB.

object

Die Programmiersprache der hochgeladenen Anwendung.

string

Der Erstellungszeitstempel 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"
        }
    ]
}

Häufige Fehler

Code	HTTP	Bedeutung
`DATABASE_UNAVAILABLE`	503	Der Dienst ist kurzzeitig nicht verfügbar. Versuche es in einigen Sekunden erneut.

Siehe auch

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

Workspaces auflisten

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"
        }
    ]
}

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Antwort

Häufige Fehler

Siehe auch

​Antwort

​Häufige Fehler

​Siehe auch

Antwort

Häufige Fehler

Siehe auch