Get the workspace
Returns the workspace the key belongs to, its brand profile and the account's plan.
Required scope: v2:org. Takes no query parameters.
brandisnullwhen the workspace has no brand profile.brand.sitecan benull.planisnullwhen the account has no subscription.
curl -X GET "https://api.opttab.com/v1/external/workspace" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.opttab.com/v1/external/workspace"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.opttab.com/v1/external/workspace", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.opttab.com/v1/external/workspace", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.opttab.com/v1/external/workspace')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"id": "11111111-1111-4111-8111-111111111111",
"name": "North brand",
"brand": {
"site": "https://north.example",
"description": "Running shoes",
"industry": "Retail"
},
"plan": {
"slug": "growth",
"status": "active"
}
}
{
"error": "API_KEY_INVALID",
"code": "UNAUTHORIZED"
}
{
"error": "API_KEY_SCOPE",
"code": "FORBIDDEN"
}
{
"error": "API_KEY_IP_DENIED",
"code": "FORBIDDEN"
}
{
"error": "ThrottlerException: Too Many Requests",
"code": "RATE_LIMITED"
}
/v1/external/workspace
Target server for requests. Edit to use your own host.
An API key secret from Settings › API. It starts with opt_live_.
Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key
header and an ?api_key= query parameter do not authenticate.
opt_live_.
Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key
header and an ?api_key= query parameter do not authenticate.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An API key secret from Settings › API. It starts with opt_live_.
Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key
header and an ?api_key= query parameter do not authenticate.
Responses
The workspace id.
The workspace name.
The brand profile. null when the workspace has none.
The account's plan. null when there is no subscription.