Get workspace by ID

GET

/api/workspaces/{workspaceId}

Production

Retrieves a single workspace by its unique identifier, including its operating configuration (country, language, currency, type) and any workspace-specific instructions.

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string format: uuid

The unique identifier of the workspace to retrieve.

Responses

200

The workspace was found and returned.

A workspace is an operational unit within a brand, typically representing a region, business unit, or product line. Conversations, knowledge base entries, policies, and channels are all scoped to a workspace.

object

required

Unique identifier for the workspace.

string format: uuid

Example

w1a2b3c4-5678-9abc-def0-1234567890ab

tenantId

required

The tenant this workspace belongs to.

string format: uuid

Example

a0b1c2d3-4567-89ab-cdef-0123456789ab

brandId

required

The brand this workspace operates under. Determines tone, sender identity, and email templates.

string format: uuid

Example

b1a2c3d4-5678-9abc-def0-1234567890ab

name

required

Display name of the workspace.

string

Example

DACH Region

country

required

ISO 3166-1 alpha-2 country code for this workspace’s primary operating region. Affects currency defaults and compliance.

string

Example

DE

operatingLanguage

required

The primary language the AI uses when communicating in this workspace. ISO 639-1 code.

string

Example

de

currency

required

ISO 4217 currency code used for financial references in this workspace.

string

Example

EUR

workspaceInstructions

Free-text instructions specific to this workspace. These are combined with brand instructions to guide the AI. Use for workspace-specific rules like regional regulations or product-specific guidance.

string | null

Example

All prices must include VAT. Refer customers to the German returns policy for DACH orders.

createdAt

required

Timestamp when the workspace was created.

string format: date-time

Example

2026-01-20T10:00:00.000Z

updatedAt

required

Timestamp when the workspace was last updated.

string format: date-time

Example

2026-03-01T16:45:00.000Z

customerType

Whether this workspace handles business-to-business or business-to-consumer conversations. Affects contact resolution, account enrichment, and AI behavior.

string

Allowed values: b2b b2c mixed

Example

b2b

signatureAdditionalHtml

Optional lines appended below the company block composed from the workspace’s legal entity (social links, awards, disclaimers). Rendered as written.

string | null

404

No workspace exists with the given ID in the authenticated tenant, or the user does not have access to it.

Standard error response returned by all endpoints on failure.

object

error

required

A human-readable error message describing what went wrong.

string

Example

Conversation not found