Workspaces
Get workspace
Returns details for a specific workspace.
GET
/
workspaces
/
{workspaceId}
Get workspace
curl --request GET \
--url https://api.example.com/workspaces/{workspaceId}import requests
url = "https://api.example.com/workspaces/{workspaceId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/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.example.com/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/workspaces/{workspaceId}"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/workspaces/{workspaceId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"displayName": "<string>",
"handle": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberRole": "owner",
"settings": {
"maxUploadBytes": 1,
"raster": "auto",
"retention": {
"auditLogs": {
"mode": "ephemeral"
},
"intermediates": {
"mode": "ephemeral"
},
"originalDocuments": {
"mode": "ephemeral"
},
"redactedDocuments": {
"mode": "ephemeral"
}
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"avatarUrl": "<string>",
"description": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}Path Parameters
Workspace identifier.
Response
Workspace response.
Workspace response.
Timestamp when the workspace was created.
Account that created this workspace.
Show child attributes
Show child attributes
Display name of the workspace.
URL-safe workspace handle. Display-only.
Required string length:
3 - 32Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Unique identifier of the workspace.
Role of the member in the workspace.
Allowed value:
"owner"Workspace settings (raster policy, data-retention rules, upload cap).
maxUploadBytes is resolved to the effective per-file limit — the smaller
of the workspace's own cap and the server-wide hard limit — so a client
always reads a concrete number to enforce.
Show child attributes
Show child attributes
Timestamp when the workspace was last updated.
Serve path of the workspace's avatar (logo), when set.
Description of the workspace.
Get workspace
curl --request GET \
--url https://api.example.com/workspaces/{workspaceId}import requests
url = "https://api.example.com/workspaces/{workspaceId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/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.example.com/workspaces/{workspaceId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/workspaces/{workspaceId}"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/workspaces/{workspaceId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/workspaces/{workspaceId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>",
"avatarUrl": "<string>",
"displayName": "<string>"
},
"displayName": "<string>",
"handle": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"memberRole": "owner",
"settings": {
"maxUploadBytes": 1,
"raster": "auto",
"retention": {
"auditLogs": {
"mode": "ephemeral"
},
"intermediates": {
"mode": "ephemeral"
},
"originalDocuments": {
"mode": "ephemeral"
},
"redactedDocuments": {
"mode": "ephemeral"
}
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"avatarUrl": "<string>",
"description": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}{
"message": "<string>",
"name": "<string>"
}