developer
PTEN

Settings API

Workspace

The company itself, as its Settings have it: its name, whether people at its domains may join by themselves, and its domains.

Base URL https://acme.yet.com.br/api/settings

Settings answer at your company’s own address — acme here — and take a key of someone who runs them.

The object

slugstring
Its address: <slug>.yet.com.br.
namestring
Shown on every app and at sign-in.
open_joinboolean
Whether anyone at its domains may join.
apps_offstring[]
The apps its people do not see.
domainsstring[]
Its verified domains.
mail_domainsstring[]
Its domains with mail here.

Get the company

GET/api/settings

The company the key belongs to.

Who: Runs the company’s Settings

Request
curl https://acme.yet.com.br/api/settings \
  -H "Authorization: Bearer $YET_API_KEY"
Response · 200
{
  "slug": "acme",
  "name": "Acme",
  "open_join": false,
  "apps_off": [
    "sketch"
  ],
  "domains": [
    "acme.dev",
    "acme.com.br"
  ],
  "mail_domains": [
    "acme.dev"
  ]
}

Change the company

PATCH/api/settings

Its name, or whether its doors are open — one of the two per request.

Who: Runs the company’s Settings

Body

namestring
A new name.
open_joinboolean
Whether anyone at its domains may join.
Request
curl -X PATCH https://acme.yet.com.br/api/settings \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "name": "Acme Inc."
  }'
Response · 200
{
  "ok": true
}