Skip to main content
GET
Get the workspace

Authorizations

Authorization
string
header
required

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

Response

200 - application/json
id
string
required
Example:

"clx..."

name
string | null

The workspace name, which is not necessarily the brand name.

Example:

"Screen Studio"

brandName
string | null

How the business refers to itself. This is the name AI visibility counts mentions of.

Example:

"Screen Studio"

domain
string | null

The domain this workspace is about. Articles are published here, and a citation or backlink pointing at it is your own rather than an opportunity.

Stored as it was entered, so it may be a bare hostname (screen.studio) or a full URL with a scheme and a trailing slash (https://screen.studio/). Elsewhere in the API a domain is always a bare hostname, so strip the scheme and any trailing slash before comparing.

Example:

"https://screen.studio/"

businessDescription
string | null

What the business does, in its own words.

Example:

"A macOS app that records your screen and turns the footage into a polished video automatically."

targetAudience
string | null

Who the business sells to.

Example:

"Indie developers, designers and founders who publish demo videos."

benefits
string | null

What the business argues is better about it.

Example:

"Automatic zooms, no editing skills needed, exports in 4K."

toneOfVoice
string | null

How generated content should sound.

Example:

"Direct and practical, no marketing filler."

industry
string | null
Example:

"Software"

location
string | null

ISO 3166-1 alpha-2 country the workspace targets. Search results, keyword volumes and rankings are all reported for this market.

Example:

"US"

language
string | null

ISO 639-1 language content is written in.

Example:

"en"