Skip to main content
GET
/
workspaces
/
{workspacePublicId}
Get a workspace by public ID
curl --request GET \
  --url https://kan.bn/api/v1/workspaces/{workspacePublicId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://kan.bn/api/v1/workspaces/{workspacePublicId}"

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

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

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

fetch('https://kan.bn/api/v1/workspaces/{workspacePublicId}', 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://kan.bn/api/v1/workspaces/{workspacePublicId}",
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://kan.bn/api/v1/workspaces/{workspacePublicId}"

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://kan.bn/api/v1/workspaces/{workspacePublicId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://kan.bn/api/v1/workspaces/{workspacePublicId}")

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
{
  "publicId": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "showEmailsToMembers": true,
  "weekStartDay": 123,
  "members": [
    {
      "publicId": "<string>",
      "role": "<string>",
      "status": "<string>",
      "createdAt": "<string>",
      "user": {
        "id": "<string>",
        "name": "<string>",
        "image": "<string>",
        "email": "<string>"
      },
      "email": "<string>"
    }
  ],
  "subscriptions": [
    {
      "plan": "<string>",
      "status": "<string>",
      "seats": 123,
      "unlimitedSeats": true,
      "partnerTier": 123,
      "periodStart": "<string>",
      "periodEnd": "<string>"
    }
  ]
}
{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}
{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}
{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}
{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspacePublicId
string
required
Minimum string length: 12

Response

Successful response

publicId
string
required
name
string
required
slug
string
required
showEmailsToMembers
boolean | null
required
weekStartDay
number | null
required
members
object[]
required
subscriptions
object[]
required