Obtenir un workspace

GET

workspaces

{workspaceId}

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

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

fetch('https://api.squarecloud.app/v2/workspaces/{workspaceId}', 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/{workspaceId}",
  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/{workspaceId}"

	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/{workspaceId}")

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 les détails complets d’un workspace : son propriétaire, la liste des membres avec leurs rôles, les applications partagées et la date de création. L’utilisateur authentifié doit en être le propriétaire ou un membre actuel ; toute autre personne, même avec seulement l’ID du workspace, obtient une erreur 404 plutôt qu’une erreur de permission, ce qui fait de cet endpoint une vérification d’existence légère. Utilisez-le après Inviter un membre ou Ajouter une application pour confirmer que le changement a bien été pris en compte, ou utilisez Lister les workspaces pour récupérer d’un coup tous les workspaces auxquels l’appelant a accès. Limité à 30 requêtes par 60 secondes par utilisateur, avec un court blocage une fois ce seuil dépassé.

Paramètres

string

requis

L’ID du 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 envoyée.

string

Le nom de l’application envoyée.

number

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

object

Le langage de programmation de l’application envoyé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
`WORKSPACE_NOT_FOUND`	404	Le workspace n’existe pas, ou l’appelant n’en est ni le propriétaire ni membre.
`DATABASE_UNAVAILABLE`	503	Le service est brièvement indisponible. Réessayez dans quelques secondes.

Voir aussi

CLI : squarecloud workspace info
SDK : api.workspaces.get() (JavaScript), client.workspaces.get() (Python), c.Workspaces.Get() (Go)

Obtenir un workspace

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

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

fetch('https://api.squarecloud.app/v2/workspaces/{workspaceId}', 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/{workspaceId}",
  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/{workspaceId}"

	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/{workspaceId}")

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

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi