Skip to navigation

Get workspace settings

View as Markdown

Returns the workspace’s timezone and its declared business country.

  • timezone is never null: a workspace that never set one, or whose stored value is no longer a valid IANA zone, gets the platform default (America/Bogota).
  • businessCountry is the ISO 3166-1 alpha-2 code the workspace declared, or null when it has not declared one.

Idempotency. Read-only and safe to retry.

Access

  • Required scope: read. Signed-in users with any role (admin, member or viewer).
  • Rate limit: General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. See Rate limits.
  • Plan: Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

ScopeGET / HEADPOST / PUT / PATCH / DELETEAdmin-only routes
readYesNoNo
writeYesYesNo
fullYesYesYes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Response

The workspace's settings.
dataobject

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error