Skip to main content
GET
Get the workspace

Authorizations

Authorization
string
header
required

An API key that starts with vms_. Make one in Settings > API keys.

Response

The workspace.

id
string
required
name
string
required
Example:

"Acme Inc"

slug
string
required

The URL of the workspace.

Example:

"acme"

website
string | null
required

The domain of the company website.

Example:

"acme.com"

language
string | null
required

The default language of the workspace.

Example:

"en"

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$