Skip to main content
GET
/
workspaces
/
{workspaceId}
Retrieve a workspace
curl --request GET \
  --url https://v1.api.altostrat.io/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://v1.api.altostrat.io/workspaces/{workspaceId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://v1.api.altostrat.io/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://v1.api.altostrat.io/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: Bearer <token>"
  ],
]);

$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://v1.api.altostrat.io/workspaces/{workspaceId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://v1.api.altostrat.io/workspaces/{workspaceId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://v1.api.altostrat.io/workspaces/{workspaceId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "ws_a1b2c3d4e5f6g7h8",
  "name": "ACME Corporation",
  "description": "Primary workspace for all ACME projects.",
  "billing_mode": "pooled",
  "pooled_seat_limit": 100,
  "archived": false,
  "created_at": "2025-10-29T00:40:06.000000Z",
  "updated_at": "2025-10-29T00:40:06.000000Z",
  "archived_at": null
}

Authorizations

Authorization
string
header
required

Enter your JWT in the format: Bearer {token}

Path Parameters

workspaceId
string
required

The ID of the workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

Response

The requested workspace object.

id
string

Unique identifier for the workspace, prefixed with ws_.

Example:

"ws_a1b2c3d4e5f6g7h8"

name
string

The name of the workspace.

Example:

"ACME Corporation"

description
string | null

An optional description for the workspace.

Example:

"Primary workspace for all ACME projects."

billing_mode
enum<string>

The billing mode for the workspace. Determines how subscriptions and usage are handled.

Available options:
single,
assigned,
pooled
Example:

"pooled"

pooled_seat_limit
integer | null

The total number of seats available in 'pooled' billing mode. This is null for other modes.

Example:

100

archived
boolean

Whether the workspace is archived.

Example:

false

created_at
string<date-time>

The timestamp when the workspace was created.

Example:

"2025-10-29T00:40:06.000000Z"

updated_at
string<date-time>

The timestamp when the workspace was last updated.

Example:

"2025-10-29T00:40:06.000000Z"

archived_at
string<date-time> | null

The timestamp when the workspace was archived.

Example:

null