Listar workspaces

GET

workspaces

Listar 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

obrigatório

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

Requer uma chave de API com o escopo workspaces:manage. Retorna todos os workspaces em que o usuário autenticado é dono ou membro, cada um já com sua lista de membros (nomes e funções) e suas aplicações compartilhadas (nome, RAM, linguagem, domínio). É o ponto de entrada ideal para montar um seletor de workspaces ou um dashboard, já que evita uma chamada a Obter workspace por workspace. A resposta é um array vazio para um usuário sem workspaces, seja porque está em um plano sem acesso a workspaces, seja simplesmente porque ainda não criou nem entrou em nenhum. Para criar o primeiro, veja Criar workspace.

Resposta

string

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

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

O ID do workspace: 32 caracteres hexadecimais (um UUID v4 sem hífens). Workspaces mais antigos têm um ID hexadecimal de 40 caracteres.

string

O ID do proprietário do Workspace.

string

O nome do Workspace.

object

A lista de membros do workspace. Ela sempre inclui o dono, com group: "owner".

Mostrar Alternar objeto

string

O ID do usuário.

string

O nome do usuário. Pode ser null, por exemplo quando a conta foi excluída.

string

As permissões do membro nas aplicações do workspace.

string

O timestamp de entrada em UTC-0.

object

A lista de aplicações do workspace.

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

Erros comuns

Código	HTTP	Significado
`DATABASE_UNAVAILABLE`	503	O serviço está brevemente indisponível. Tente novamente em alguns segundos.

Relacionados

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

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

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Resposta

Erros comuns

Relacionados

​Resposta

​Erros comuns

​Relacionados

Resposta

Erros comuns

Relacionados