Get Workspace
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}import requests
url = "https://api.vertracloud.app/v1/workspaces/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/workspaces/{id}', 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.vertracloud.app/v1/workspaces/{id}",
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.vertracloud.app/v1/workspaces/{id}"
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.vertracloud.app/v1/workspaces/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/workspaces/{id}")
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{
"response": {
"members": [
{}
],
"roles": [
{}
],
"applications": [
{}
],
"databases": [
{}
],
"permissions": [
{}
],
"is_owner": true,
"resource_organization": {
"scope": "<string>",
"user_id": "<string>",
"workspace_id": "<string>",
"folders": [
{}
],
"favorites": [
{}
]
}
}
}Workspaces
Get Workspace
Returns full workspace details, the caller’s permissions and their individual resource organization.
GET
/
v1
/
workspaces
/
{id}
Get Workspace
curl --request GET \
--url https://api.vertracloud.app/v1/workspaces/{id}import requests
url = "https://api.vertracloud.app/v1/workspaces/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.vertracloud.app/v1/workspaces/{id}', 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.vertracloud.app/v1/workspaces/{id}",
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.vertracloud.app/v1/workspaces/{id}"
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.vertracloud.app/v1/workspaces/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vertracloud.app/v1/workspaces/{id}")
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{
"response": {
"members": [
{}
],
"roles": [
{}
],
"applications": [
{}
],
"databases": [
{}
],
"permissions": [
{}
],
"is_owner": true,
"resource_organization": {
"scope": "<string>",
"user_id": "<string>",
"workspace_id": "<string>",
"folders": [
{}
],
"favorites": [
{}
]
}
}
}Any member can call this (there’s no read permission gate on the workspace itself — you either
belong to it or you get
404). An API key needs the workspaces:read scope.
A workspace that doesn’t exist and one you don’t belong to answer the same way:
404 WORKSPACE_NOT_FOUND. That’s deliberate — telling the two apart would leak which
workspace IDs exist.Path
string
required
Workspace ID.
Response
APIWorkspaceInfoResponse
Everything from List Workspaces, plus:
Show Toggle object
Show Toggle object
APIWorkspaceMember[]
Full member list, same shape as List Members.
APIWorkspaceRole[]
Full role list, same shape as List Roles.
APIApplication[]
Applications linked to this workspace.
APIDatabase[]
Databases linked to this workspace.
WorkspacePermission[]
The caller’s resolved permissions. The owner gets the full 21-permission catalog without needing a role row.
boolean
APIWorkspaceResourceOrganization
Personal organization of the member who made this request in this workspace. It has
scope set to
workspace, user_id, workspace_id, folders and favorites; it is not a configuration
shared with other members. See the folder and favorite mutations.Show Toggle object
Show Toggle object
string
Always
workspace in this response.string
ID of the member who made the request.
string
ID of this workspace.
APIWorkspaceResourceFolder[]
Personal folders with
id, name, color, position, resources, created_at and
updated_at. color is neutral, red, orange, yellow, green, blue or purple.APIWorkspaceFavorite[]
Individual favorites with
resource_type (application or database), resource_id,
position and created_at.Errors
| Status | Code | When |
|---|---|---|
| 404 | WORKSPACE_NOT_FOUND | Workspace doesn’t exist, is soft-deleted, or you’re not a member. |