Lister les workspaces

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope workspaces:manage. Renvoie tous les workspaces dont l’utilisateur authentifié est propriétaire ou membre, chacun enrichi de sa liste de membres (noms et rôles) et de ses applications partagées (nom, RAM, langage, domaine). C’est le point d’entrée idéal pour construire un sélecteur de workspace ou un tableau de bord, car il évite un appel Obtenir un workspace par workspace. La réponse est un tableau vide pour un utilisateur sans workspace, que ce soit parce qu’il est sur un plan sans accès aux workspaces ou simplement parce qu’il n’en a créé ou rejoint aucun. Pour créer le premier, consultez Créer un workspace.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

string

L’ID du workspace : 32 caractères hexadécimaux (un UUID v4 sans tirets). Les workspaces plus anciens ont un ID hexadécimal de 40 caractères.

string

L’ID du propriétaire du workspace.

string

Le nom du workspace.

object

La liste des membres du workspace. Elle inclut toujours le propriétaire, avec group: "owner".

Afficher Afficher l'objet

string

L’ID de l’utilisateur.

string

Le nom de l’utilisateur. Peut valoir null, par exemple lorsque le compte a été supprimé.

string

Les permissions du membre sur les applications du workspace.

string

L’horodatage d’adhésion en UTC-0.

object

La liste des applications du workspace.

Afficher Afficher l'objet

string

L’ID de l’application déployée.

string

Le nom de l’application déployée.

number

L’utilisation de RAM de l’application déployée en Mo.

object

Le langage de programmation de l’application déployée.

string

L’horodatage de création en 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"
        }
    ]
}

Erreurs courantes

Code	HTTP	Signification
`DATABASE_UNAVAILABLE`	503	Le service est brièvement indisponible. Réessayez dans quelques secondes.

Voir aussi

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

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

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Réponse

Erreurs courantes

Voir aussi

​Réponse

​Erreurs courantes

​Voir aussi

Réponse

Erreurs courantes

Voir aussi