Skip to main content
GET
Retrieve the workspace

Authorizations

X-API-KEY
string
header
required

Response

OK

brandName
string

Display name of the brand shown to clients.

Example:

"Acme Inc."

colorAccent
string

Hex accent color used throughout the client portal.

Example:

"#3a70e8"

colorSidebarBackground
string

Hex color of the client sidebar background.

Example:

"#ffffff"

colorSidebarText
string

Hex color of the client sidebar text.

Example:

"#000000"

font
string

Font family used in the client portal.

Example:

"Inter"

fullLogoUrl
string<uri>

URL of the full logo used for the workspace.

Example:

"https://cdn.assembly.com/logo.png"

id
string<uuid>

Unique identifier of the workspace (portal).

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

industry
string

Industry selected for the workspace during onboarding.

Example:

"Marketing"

isClientDirectSignUpEnabled
boolean

Whether clients can sign up directly without an invitation.

Example:

false

isCompaniesEnabled
boolean

Whether the companies feature is enabled for the workspace.

Example:

true

labels
object

Custom terminology configured for the workspace.

logOutUrl
string<uri>

URL clients are redirected to after signing out.

Example:

"https://example.com/logout"

metaDescription
string

Page description used in meta tags.

Example:

"Manage your projects with Acme."

metaTitle
string

Page title shown in the browser tab and meta tags.

Example:

"Acme Client Portal"

portalUrl
string<uri>

Fully qualified URL of the client-facing portal.

Example:

"clients.acme.com"

socialSharingImageUrl
string<uri>

URL of the image used when the workspace is shared on social media.

Example:

"https://cdn.assembly.com/social.png"

squareIconUrl
string<uri>

URL of the square icon used for the workspace.

Example:

"https://cdn.assembly.com/icon.png"

squareLoginImageUrl
string<uri>

URL of the square image shown on the login screen.

Example:

"https://cdn.assembly.com/login.png"