curl --request GET \
--url https://api.assembly.com/v1/workspaces \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.assembly.com/v1/workspaces"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.assembly.com/v1/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.assembly.com/v1/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 => [
"X-API-KEY: <api-key>"
],
]);
$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.assembly.com/v1/workspaces"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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.assembly.com/v1/workspaces")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"brandName": "Acme Inc.",
"colorAccent": "#3a70e8",
"colorSidebarBackground": "#ffffff",
"colorSidebarText": "#000000",
"font": "Inter",
"fullLogoUrl": "https://cdn.assembly.com/logo.png",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"industry": "Marketing",
"isClientDirectSignUpEnabled": false,
"isCompaniesEnabled": true,
"labels": {
"groupTerm": "Company",
"groupTermPlural": "Companies",
"individualTerm": "Client",
"individualTermPlural": "Clients"
},
"logOutUrl": "https://example.com/logout",
"metaDescription": "Manage your projects with Acme.",
"metaTitle": "Acme Client Portal",
"portalUrl": "clients.acme.com",
"socialSharingImageUrl": "https://cdn.assembly.com/social.png",
"squareIconUrl": "https://cdn.assembly.com/icon.png",
"squareLoginImageUrl": "https://cdn.assembly.com/login.png"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Retrieve the workspace
Returns the configuration and branding of the workspace associated with the authenticated API key’s portal.
curl --request GET \
--url https://api.assembly.com/v1/workspaces \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.assembly.com/v1/workspaces"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.assembly.com/v1/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.assembly.com/v1/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 => [
"X-API-KEY: <api-key>"
],
]);
$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.assembly.com/v1/workspaces"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
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.assembly.com/v1/workspaces")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"brandName": "Acme Inc.",
"colorAccent": "#3a70e8",
"colorSidebarBackground": "#ffffff",
"colorSidebarText": "#000000",
"font": "Inter",
"fullLogoUrl": "https://cdn.assembly.com/logo.png",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"industry": "Marketing",
"isClientDirectSignUpEnabled": false,
"isCompaniesEnabled": true,
"labels": {
"groupTerm": "Company",
"groupTermPlural": "Companies",
"individualTerm": "Client",
"individualTermPlural": "Clients"
},
"logOutUrl": "https://example.com/logout",
"metaDescription": "Manage your projects with Acme.",
"metaTitle": "Acme Client Portal",
"portalUrl": "clients.acme.com",
"socialSharingImageUrl": "https://cdn.assembly.com/social.png",
"squareIconUrl": "https://cdn.assembly.com/icon.png",
"squareLoginImageUrl": "https://cdn.assembly.com/login.png"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Authorizations
Response
OK
Display name of the brand shown to clients.
"Acme Inc."
Hex accent color used throughout the client portal.
"#3a70e8"
Hex color of the client sidebar background.
"#ffffff"
Hex color of the client sidebar text.
"#000000"
Font family used in the client portal.
"Inter"
URL of the full logo used for the workspace.
"https://cdn.assembly.com/logo.png"
Unique identifier of the workspace (portal).
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Industry selected for the workspace during onboarding.
"Marketing"
Whether clients can sign up directly without an invitation.
false
Whether the companies feature is enabled for the workspace.
true
Custom terminology configured for the workspace.
Show child attributes
Show child attributes
URL clients are redirected to after signing out.
"https://example.com/logout"
Page description used in meta tags.
"Manage your projects with Acme."
Page title shown in the browser tab and meta tags.
"Acme Client Portal"
Fully qualified URL of the client-facing portal.
"clients.acme.com"
URL of the image used when the workspace is shared on social media.
"https://cdn.assembly.com/social.png"
URL of the square icon used for the workspace.
"https://cdn.assembly.com/icon.png"
URL of the square image shown on the login screen.
"https://cdn.assembly.com/login.png"