Skip to main content
GET
/
accounts
/
workspaces
cURL
curl --request GET \
  --url https://api.mudstack.com/accounts/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'x-account-id: <x-account-id>'
import requests

url = "https://api.mudstack.com/accounts/workspaces"

headers = {
    "x-account-id": "<x-account-id>",
    "Authorization": "Bearer <token>"
}

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

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

fetch('https://api.mudstack.com/accounts/workspaces', 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://api.mudstack.com/accounts/workspaces",
  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-account-id: <x-account-id>"
  ],
]);

$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://api.mudstack.com/accounts/workspaces"

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

	req.Header.Add("x-account-id", "<x-account-id>")
	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://api.mudstack.com/accounts/workspaces")
  .header("x-account-id", "<x-account-id>")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.mudstack.com/accounts/workspaces")

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

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

response = http.request(request)
puts response.read_body
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "thumbnail_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "defaultAvatar": 1,
    "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sequence": "<string>",
    "roles": {
      "workspace_id": "<string>",
      "user_id": "<string>",
      "roles": [
        "<string>"
      ],
      "user": {
        "id": "<string>",
        "auth0UserID": "<string>",
        "username": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "avatar_file_id": "<string>",
        "defaultAvatar": 123,
        "industry": "<string>",
        "occupation": "<string>",
        "company": "<string>",
        "emailVerified": true,
        "isActive": true,
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "zipCode": "<string>",
        "invited_by_user": "<unknown>"
      }
    },
    "usage": {}
  }
]

Authorizations

Authorization
string
header
required

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

Headers

x-account-id
string<uuid>
required

Response

200 - application/json

Workspaces retrieved successfully

id
string<uuid>

Unique identifier for the workspace.

account_id
string<uuid>

Unique identifier for the account associated with the workspace.

name
string

Name of the workspace.

thumbnail_file_id
string<uuid>

Unique identifier for the thumbnail file associated with the workspace.

defaultAvatar
integer
default:1

Default avatar for the workspace.

Required range: 1 <= x <= 10
created_by_user_id
string<uuid>

Unique identifier for the user who created the workspace.

sequence
string<bigint>

Sequence number for the workspace.

roles
object

Roles associated with the workspace.

usage
object

Usage information for the workspace.