Workspace
Get Workspace
Get workspace info.
GET
/
v2
/
workspaces
/
{workspaceId}
Get Workspace
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
required
The API key for your account. You can find this in your account settings.
Parameters
string
The ID of the workspace.
Response
string
Indicates whether the call was successful..
success if successful, error if not.object
The contents of the response.
Show Toggle object
Show Toggle object
string
The ID of the Workspace.
string
The Workspace owner id.
string
The name of the Workspace.
object
object
string
The creation timestamp in 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"
}
}
Common errors
| Code | HTTP | Meaning |
|---|---|---|
WORKSPACE_NOT_FOUND | 404 | The workspace does not exist, or the caller is neither its owner nor a member. |
⌘I
Get Workspace
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"
}
}

