Get a workspace
Returns one workspace with the teams assigned to it and when each was assigned. Send id or workspace_id.
Requires a realm member (or higher) on the realm that owns the workspace given by workspace_id or id.
POST
/
v1
/
workspaces
/
get_by_id
Get a workspace
curl --request POST \
--url https://{host}/v1/workspaces/get_by_id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f"
}
'import requests
url = "https://{host}/v1/workspaces/get_by_id"
payload = { "id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f'})
};
fetch('https://{host}/v1/workspaces/get_by_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://{host}/v1/workspaces/get_by_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/v1/workspaces/get_by_id"
payload := strings.NewReader("{\n \"id\": \"9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/v1/workspaces/get_by_id")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/workspaces/get_by_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"workspace": {
"id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
"workspace_id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
"path": "/home/dev/acme-api",
"workspace_dir": "/home/dev/acme-api",
"name": "acme-api",
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"registered": true,
"exists": true,
"assembled": true,
"teams": [
{
"team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
"slug": "code-review",
"scope": "acme"
}
],
"active_runs": [],
"latest_run": {
"run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
"state": "completed",
"started_at": 1759834200000
},
"created_at": 1759000000000,
"updated_at": 1759834200000
},
"teams": [
{
"team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
"scope": "acme",
"slug": "code-review",
"assembled_at": 1759000100000
}
]
}
Authorizations
User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).
Body
application/json
⌘I
Get a workspace
curl --request POST \
--url https://{host}/v1/workspaces/get_by_id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f"
}
'import requests
url = "https://{host}/v1/workspaces/get_by_id"
payload = { "id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({id: '9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f'})
};
fetch('https://{host}/v1/workspaces/get_by_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://{host}/v1/workspaces/get_by_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{host}/v1/workspaces/get_by_id"
payload := strings.NewReader("{\n \"id\": \"9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{host}/v1/workspaces/get_by_id")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/workspaces/get_by_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"workspace": {
"id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
"workspace_id": "9b2e6f10-4c3a-4e7d-8f21-6a5b4c3d2e1f",
"path": "/home/dev/acme-api",
"workspace_dir": "/home/dev/acme-api",
"name": "acme-api",
"daemon_id": "7d1c2b3a-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"registered": true,
"exists": true,
"assembled": true,
"teams": [
{
"team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
"slug": "code-review",
"scope": "acme"
}
],
"active_runs": [],
"latest_run": {
"run_id": "0c8d7e6f-5a4b-4c3d-9e2f-1a0b9c8d7e6f",
"state": "completed",
"started_at": 1759834200000
},
"created_at": 1759000000000,
"updated_at": 1759834200000
},
"teams": [
{
"team_id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
"scope": "acme",
"slug": "code-review",
"assembled_at": 1759000100000
}
]
}