Settings API

People

Everyone of the company: with a mailbox here, and those who only sign in with an address elsewhere.

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

idstring: The person’s id.
namestring: Their mailbox’s name, before the @.
emailstring: The address they sign in with.
full_namestring: Their name.
runs_settingsboolean: Whether they may open Settings.
lockedboolean: Locked after too many wrong passwords.
created_atstring: When they were added (RFC 3339).

List people

GET/api/settings/people

Those with a mailbox here (people), and those who only sign in (members).

Quem: Runs the company’s Settings

Requisição

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

Resposta · 200

{
  "people": [
    {
      "id": "3c",
      "name": "ana",
      "email": "ana@acme.dev",
      "full_name": "Ana Costa",
      "runs_settings": true,
      "locked": false,
      "created_at": "2026-10-23T12:00:00Z"
    }
  ],
  "members": [
    {
      "email": "bruno@gmail.com",
      "created_at": "2026-10-23T12:00:00Z"
    }
  ]
}

Add someone

POST/api/settings/people/add

Invited at their own address, or given a password now; with a mailbox here — at the first of mailbox.domains, an alias at each of the others — or none. An address at one of the company’s domains with mail has no mailbox yet, so an invitation there would reach nobody: give it a password and that mailbox.

Quem: Runs the company’s Settings

Corpo

full_namestring: Their name.
emailstring: Where the invitation goes; may be empty with a password and a mailbox.
via"invite" | "password"obrigatório: How they get in.
passwordstring: With via: "password": at least 8 characters.
mailbox{ name, domains[] } | nullobrigatório: Their mailbox here, or null.
runs_settingsboolean: Whether they may open Settings.

Requisição

curl -X POST https://acme.yet.com.br/api/settings/people/add \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "full_name": "Ana Costa",
    "email": "",
    "via": "password",
    "password": "correct-horse-battery",
    "mailbox": {
      "name": "ana",
      "domains": [
        "acme.dev",
        "acme.com.br"
      ]
    },
    "runs_settings": false
  }'

Resposta · 200

{
  "email": "ana@acme.dev"
}

Change someone

PATCH/api/settings/people/{id}

One change per request: their name (on their sign-in and their mailbox), a new password, or whether they run Settings.

Quem: Runs the company’s Settings

Corpo

full_namestring: Their new name.
passwordstring: A new password, at least 8 characters.
runs_settingsboolean: Whether they may open Settings. Never your own, off.

Requisição

curl -X PATCH https://acme.yet.com.br/api/settings/people/{id} \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "full_name": "Ana Costa Lima"
  }'

Resposta · 200

{
  "ok": true
}

Remove someone

DELETE/api/settings/people/{id}

Their sign-in goes, and their mailbox with every message in it. It cannot be undone.

Quem: Runs the company’s Settings

Requisição

curl -X DELETE https://acme.yet.com.br/api/settings/people/{id} \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 200

{
  "ok": true
}

Remove someone without a mailbox

DELETE/api/settings/people/members/{email}

Their sign-in goes; at one of the company’s domains, it would let them in again otherwise.

Quem: Runs the company’s Settings

Requisição

curl -X DELETE https://acme.yet.com.br/api/settings/people/members/{email} \
  -H "Authorization: Bearer $YET_API_KEY"

Resposta · 200

{
  "ok": true
}

Invite someone at a company domain

POST/api/settings/people/invite

A link to their address, for a day: they set their password at it.

Quem: Runs the company’s Settings

Corpo

emailstringobrigatório: Their address.

Requisição

curl -X POST https://acme.yet.com.br/api/settings/people/invite \
  -H "Authorization: Bearer $YET_API_KEY" \
  -d '{
    "email": "bruno@acme.dev"
  }'