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.

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

Settings respondem no endereço da sua empresa — acme aqui — e aceitam a key de quem administra o Settings.

As descrições dos endpoints estão em inglês.

O objeto

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.

Quem: Runs the company’s Settings

Requisição

curl https://acme.yet.com.br/api/settings \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 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.

Quem: Runs the company’s Settings

Corpo

namestring: A new name.
open_joinboolean: Whether anyone at its domains may join.

Requisição

curl -X PATCH https://acme.yet.com.br/api/settings \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "name": "Acme Inc."
  }'

Resposta · 200

{
  "ok": true
}