Obter espaço de trabalho

GET

workspaces

{workspaceId}

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

import requests

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

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/workspaces/{workspaceId}")
  .header("Authorization", "<authorization>")
  .asString();

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

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Retorna os detalhes completos de um espaço de trabalho: seu dono, a lista de membros com seus papéis, as aplicações compartilhadas e a data de criação. O usuário autenticado precisa ser o dono ou um membro atual; qualquer outra pessoa, mesmo tendo apenas o ID do espaço de trabalho, recebe um 404 em vez de um erro de permissão, então o endpoint também funciona como uma verificação leve de existência. Use este endpoint depois de Convidar membro ou Adicionar aplicação para confirmar que a mudança foi aplicada, ou use Listar espaços de trabalho para buscar de uma vez todos os espaços de trabalho aos quais o solicitante tem acesso. Limitado a 30 requisições a cada 60 segundos por usuário, com bloqueio de 60 segundos ao exceder o limite.

Parâmetros

string

O ID do espaço de trabalho.

Resposta

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID do Espaço de Trabalho.

string

O ID do proprietário do Espaço de Trabalho.

string

O nome do Espaço de Trabalho.

object

A lista de membros do espaço de trabalho.

Mostrar Alternar objeto

string

O ID do usuário.

string

O nome do usuário.

string

As permissões do membro nas aplicações do espaço de trabalho.

string

O timestamp de entrada em UTC-0.

object

A lista de aplicações do espaço de trabalho.

Mostrar Alternar objeto

string

O ID da aplicação enviada.

string

O nome da aplicação enviada.

number

O uso de RAM da aplicação enviada em MB.

object

A linguagem de programação da aplicação enviada.

string

O timestamp de criação em 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"
  }
}

Erros comuns

Código	HTTP	Significado
`WORKSPACE_NOT_FOUND`	404	O espaço de trabalho não existe, ou o solicitante não é o dono nem um membro.

Sair do espaço de trabalhoSair do espaço de trabalho.

Obter espaço de trabalho

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

import requests

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

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

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))

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/workspaces/{workspaceId}")
  .header("Authorization", "<authorization>")
  .asString();

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

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns