Skip to main content
GET
/
v1
/
workspaces
/
{id}
Get Workspace by ID
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": {
    "id": "org123",
    "name": "myworkspace",
    "description": "I have a description :)",
    "tags": ["discord", "programming"],
    "owner_id": "993591427428790342",
    "plan_id": 1,
    "members": [
      {
        "user_id": "993591427428790342",
        "role": "owner",
        "joined_at": "2026-03-14T19:58:00Z"
      }
    ],
    "applications": [
      {
        "id": "v111d4af8cd74272a284831fbae14a8v",
        "cluster": 1,
        "type": 1,
        "name": "Simple API",
        "description": "I have a description :)",
        "owner_id": "993591427428790342",
        "owner_plan_id": 1,
        "language": "javascript",
        "ram": 128,
        "status": "up",
        "subdomain": null,
        "custom_domain": null,
        "last_snapshot": "2026-03-09T15:51:47.234Z",
        "created_at": "2026-03-09T15:51:47.234Z",
        "updated_at": "2026-03-11T15:06:41.449Z"
      }
    ],
    "databases": [
      {
        "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
        "cluster": 1,
        "type": 3,
        "name": "MyDatabase",
        "description": "I have a description :)",
        "owner_id": "993591427428790342",
        "owner_plan_id": 1,
        "status": "up",
        "ram": 256,
        "host": "639d9aa35d8b4e559bcd066db4ddcc8c.db.usa1.vertraweb.app",
        "port": 12748,
        "last_snapshot": "2026-03-14T19:58:00Z",
        "created_at": "2026-03-14T19:58:00Z",
        "updated_at": "2026-03-14T19:58:00Z"
      }
    ],
    "created_at": "2026-03-14T19:58:00Z",
    "updated_at": "2026-03-14T19:58:00Z"
  }
}
​
id
string
required
The ID of the workspace to retrieve.

​
Response

​
response
object
The details of the workspace.
{
  "response": {
    "id": "org123",
    "name": "myworkspace",
    "description": "I have a description :)",
    "tags": ["discord", "programming"],
    "owner_id": "993591427428790342",
    "plan_id": 1,
    "members": [
      {
        "user_id": "993591427428790342",
        "role": "owner",
        "joined_at": "2026-03-14T19:58:00Z"
      }
    ],
    "applications": [
      {
        "id": "v111d4af8cd74272a284831fbae14a8v",
        "cluster": 1,
        "type": 1,
        "name": "Simple API",
        "description": "I have a description :)",
        "owner_id": "993591427428790342",
        "owner_plan_id": 1,
        "language": "javascript",
        "ram": 128,
        "status": "up",
        "subdomain": null,
        "custom_domain": null,
        "last_snapshot": "2026-03-09T15:51:47.234Z",
        "created_at": "2026-03-09T15:51:47.234Z",
        "updated_at": "2026-03-11T15:06:41.449Z"
      }
    ],
    "databases": [
      {
        "id": "639d9aa35d8b4e559bcd066db4ddcc8c",
        "cluster": 1,
        "type": 3,
        "name": "MyDatabase",
        "description": "I have a description :)",
        "owner_id": "993591427428790342",
        "owner_plan_id": 1,
        "status": "up",
        "ram": 256,
        "host": "639d9aa35d8b4e559bcd066db4ddcc8c.db.usa1.vertraweb.app",
        "port": 12748,
        "last_snapshot": "2026-03-14T19:58:00Z",
        "created_at": "2026-03-14T19:58:00Z",
        "updated_at": "2026-03-14T19:58:00Z"
      }
    ],
    "created_at": "2026-03-14T19:58:00Z",
    "updated_at": "2026-03-14T19:58:00Z"
  }
}

​
Error Responses

​
code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated.
  • ORGANIZATION_NOT_FOUND: The specified workspace does not exist.
  • NOT_ORGANIZATION_MEMBER: The user is not a member of the workspace.
​
message
string
A descriptive message providing additional details about the error.
{
  "code": "UNAUTHORIZED"
}

{
  "code": "ORGANIZATION_NOT_FOUND"
}

{
  "code": "NOT_ORGANIZATION_MEMBER"
}