Obtener workspace - Square Cloud

GET

workspaces

{workspaceId}

Obtener 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": "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"
  }
}

string

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Devuelve los detalles completos de un único workspace: su propietario, la lista de miembros con sus roles, las aplicaciones compartidas y la fecha de creación. El usuario autenticado debe ser el propietario o un miembro actual; cualquier otra persona, incluso alguien que solo tenga el ID del workspace, recibe un 404 en lugar de un error de permisos, por lo que el endpoint también sirve como una comprobación ligera de existencia. Úsalo después de Invitar miembro o Agregar aplicación para confirmar que el cambio se aplicó, o usa Listar workspaces para obtener de una sola vez todos los workspaces a los que tiene acceso el usuario. Limitado a 30 solicitudes cada 60 segundos por usuario, con un bloqueo de 60 segundos al superarlo.

Parámetros

string

El ID del workspace.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

El ID del workspace.

string

El ID del propietario del workspace.

string

El nombre del workspace.

object

La lista de miembros del workspace.

Mostrar Alternar objeto

string

El ID del usuario.

string

El nombre del usuario.

string

Los permisos del miembro sobre las aplicaciones del workspace.

string

La marca de tiempo de ingreso en UTC-0.

object

La lista de aplicaciones del workspace.

Mostrar Alternar objeto

string

El ID de la aplicación subida.

string

El nombre de la aplicación subida.

number

El uso de RAM de la aplicación subida en MB.

object

El lenguaje de programación de la aplicación subida.

string

La marca de tiempo de creación en UTC-0.

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

Errores comunes

Código	HTTP	Significado
`WORKSPACE_NOT_FOUND`	404	El workspace no existe, o el usuario que realiza la llamada no es su propietario ni miembro.

Salir del workspaceSal de un workspace.

Obtener 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": "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"
  }
}

​Parámetros

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes