workspace
Get a workspace
Returns a single workspace by its ID or slug.
GET
/
v1
/
workspace
/
{ws}
cURL
curl -X GET 'http://localhost:8080/v1/workspace/ws_example' \
-H 'Authorization: Bearer ek_live_xxxxx'const response = await fetch('http://localhost:8080/v1/workspace/ws_example', {
method: 'GET',
headers: {
Authorization: 'Bearer ek_live_xxxxx',
},
});
const data = await response.json();import requests
response = requests.get(
'http://localhost:8080/v1/workspace/ws_example',
headers={
'Authorization': 'Bearer ek_live_xxxxx',
},
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/v1/workspace/{ws}",
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 := "http://localhost:8080/v1/workspace/{ws}"
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("http://localhost:8080/v1/workspace/{ws}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/workspace/{ws}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"ownerId": "<string>"
}Authorizations
API key authentication. Pass Authorization: Bearer ek_live_xxxxx on every request.
Path Parameters
Required string length:
2 - 48Pattern:
^[a-z0-9-]+$Previous
Update a workspaceUpdates the name or slug of a workspace. Changing the slug rewrites every URL that uses it. Update your environment configuration accordingly.
Next
⌘I
cURL
curl -X GET 'http://localhost:8080/v1/workspace/ws_example' \
-H 'Authorization: Bearer ek_live_xxxxx'const response = await fetch('http://localhost:8080/v1/workspace/ws_example', {
method: 'GET',
headers: {
Authorization: 'Bearer ek_live_xxxxx',
},
});
const data = await response.json();import requests
response = requests.get(
'http://localhost:8080/v1/workspace/ws_example',
headers={
'Authorization': 'Bearer ek_live_xxxxx',
},
)
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/v1/workspace/{ws}",
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 := "http://localhost:8080/v1/workspace/{ws}"
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("http://localhost:8080/v1/workspace/{ws}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/workspace/{ws}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"ownerId": "<string>"
}