Get Workspace

GET /workspace

Get workspace metadata

cURL

curl --request GET \
  --url https://crossproductroadmapbackend.vercel.app/api/v1/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-slug: <x-tenant-slug>'

import requests

url = "https://crossproductroadmapbackend.vercel.app/api/v1/workspace"

headers = {
    "x-tenant-slug": "<x-tenant-slug>",
    "Authorization": "Bearer <token>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-slug': '<x-tenant-slug>', Authorization: 'Bearer <token>'}
};

fetch('https://crossproductroadmapbackend.vercel.app/api/v1/workspace', 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://crossproductroadmapbackend.vercel.app/api/v1/workspace",
  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>",
    "x-tenant-slug: <x-tenant-slug>"
  ],
]);

$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://crossproductroadmapbackend.vercel.app/api/v1/workspace"

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

	req.Header.Add("x-tenant-slug", "<x-tenant-slug>")
	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://crossproductroadmapbackend.vercel.app/api/v1/workspace")
  .header("x-tenant-slug", "<x-tenant-slug>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://crossproductroadmapbackend.vercel.app/api/v1/workspace")

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

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

response = http.request(request)
puts response.read_body

200

{
  "name": "Acme Corp",
  "slug": "acme",
  "plan": "free"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

ApiKeyAuthOAuthBearer

Authorization · string · header · required

Generate an API key in your workspace Settings → API Keys. Pass it as Authorization: Bearer tab_<key> on every request.

Headers

x-tenant-slug · string · required

Your workspace slug (e.g. acme).

Response

200

application/json

OK

name · string · required

Example:

"Acme Corp"

slug · string · required

Example:

"acme"

plan · enum<string> · required

Available options: free, pro, enterprise

Example:

"free"