GET /workspace returns the workspace identity and the timezone, currency, and country defaults to use when interpreting dates and money from other resources.
A deliberately small resource API for server-side Twelfth integrations. It starts with workspace identity and current task reads; new resources are added only after their contracts and permissions are ready.
**Authentication.** Send a workspace API key as `Authorization: Bearer <key>`. Give each server, script or automation its own labelled key and never expose a key in browser code.
**Errors.** Every error is `application/problem+json` (RFC 9457), with a stable machine-readable `code` and a recovery `hint`.
**Compatibility.** Paths are stable and unversioned. Published operations evolve additively: existing paths, fields and documented error codes remain supported.
**Rate limits.** Responses carry `RateLimit-*` headers; a `429` also carries `Retry-After`.
GET/workspace
Get the workspace
Returns the identity and operating defaults of the workspace attached to the API key. Use these timezone, currency and country values when interpreting dates and money from later resources.
Responses
Status
Description
200
The workspace attached to the API key. WorkspaceResponse
200 body
application/json
Field
Type
Description
Example
workspace*
WorkspaceShow fields
Field
Type
Description
Example
id*
string
Stable workspace identifier.
org_01JABCDEFGHJKMNPQRSTVWXYZ
name*
string
Display name.
Northstar Retail
slug*
string
Human-readable workspace slug.
northstar-retail
timezone*
string,null
IANA timezone used for business dates.
Australia/Melbourne
currencyCode*
string,null
ISO 4217 reporting currency.
AUD
countryCode*
string,null
ISO 3166-1 alpha-2 country code.
AU
401
The workspace API key is missing, invalid or revoked. Problem
401 body
application/problem+json
Field
Type
Description
Example
type*
string:uri-reference
about:blank
title*
string
Short, human-readable summary.
status*
integer
HTTP status code.
401
code*
string
Stable error code for programmatic handling.
unauthorized
detail*
string
Explanation specific to this occurrence.
hint*
string
How to resolve or work around the error.
404
The key no longer refers to an available workspace. Problem
404 body
application/problem+json
Field
Type
Description
Example
type*
string:uri-reference
about:blank
title*
string
Short, human-readable summary.
status*
integer
HTTP status code.
401
code*
string
Stable error code for programmatic handling.
unauthorized
detail*
string
Explanation specific to this occurrence.
hint*
string
How to resolve or work around the error.
405
The resource is read-only. Problem
405 body
application/problem+json
Field
Type
Description
Example
type*
string:uri-reference
about:blank
title*
string
Short, human-readable summary.
status*
integer
HTTP status code.
401
code*
string
Stable error code for programmatic handling.
unauthorized
detail*
string
Explanation specific to this occurrence.
hint*
string
How to resolve or work around the error.
429
Rate limit exceeded. Retry after the window resets. Problem