Get a workspace by slug

Retrieves a workspace by its slug

GET /workspaces/{workspaceSlug}

Get a workspace by slug

cURL

curl --request GET \
  --url https://opscape.com/api/v1/workspaces/{workspaceSlug}

import requests

url = "https://opscape.com/api/v1/workspaces/{workspaceSlug}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://opscape.com/api/v1/workspaces/{workspaceSlug}', 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://opscape.com/api/v1/workspaces/{workspaceSlug}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://opscape.com/api/v1/workspaces/{workspaceSlug}"

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://opscape.com/api/v1/workspaces/{workspaceSlug}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://opscape.com/api/v1/workspaces/{workspaceSlug}")

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

request = Net::HTTP::Get.new(url)

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

200

{
  "publicId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "slug": "<string>",
  "boards": [
    {
      "publicId": "<string>",
      "slug": "<string>",
      "name": "<string>"
    }
  ]
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Path Parameters

workspaceSlug · string · required

Required string length: 3 - 64

Pattern: ^(?![-]+$)[a-zA-Z0-9-]+$

Response

200

application/json

Successful response

publicId · string · required

name · string · required

description · string | null · required

slug · string · required

boards · object[] · required

Show child attributes