> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Workspaces

> Crie, consulte e edite workspaces — a pasta isolada de instâncias, chaves, plano e equipe.

<Tip>
  Workspace é a **pasta do cliente** na Notifique: instâncias, chaves, plano, saldo e webhooks ficam todos dentro dela.
</Tip>

## Em poucas palavras

* Toda chamada `/v1/...` roda no workspace da sua **API Key**
* Um workspace **não enxerga** dados de outro
* O **primeiro workspace** nasce no `POST /v1/platform/verify` (registro) — não no `register`
* Workspaces adicionais: `POST /v1/workspaces` com escopo `workspace:create`
* Na API v1 **não envie** o cabeçalho `x-workspace-id` — o workspace vem só da API Key. Se enviado, a API responde **400** (`WORKSPACE_HEADER_NOT_ALLOWED`).

## Primeiro vs segundo workspace

| Momento                   | Como                                                               | Resultado                                      |
| ------------------------- | ------------------------------------------------------------------ | ---------------------------------------------- |
| Nova conta                | `register` → `verify` com OTP                                      | `workspaceId` do workspace inicial + `apiKey`  |
| Conta existente           | `POST /v1/workspaces` com API key                                  | `data.id` do novo workspace                    |
| Trocar chave de workspace | `POST /v1/platform/login` com `workspaceId` + `createApiKey: true` | Nova `apiKey` vinculada ao workspace escolhido |

Fluxo completo para agentes: [Registro e verificação](/platform-api/como-funciona/registro-e-verificacao).

## Quando usar um ou vários?

| Situação                         | Recomendação                |
| -------------------------------- | --------------------------- |
| Uma marca, um time               | **1 workspace**             |
| Produção e homologação separados | **2 workspaces**            |
| SaaS com um cliente por conta    | **1 workspace por cliente** |

## API (`/v1/workspaces`)

Escopos: `workspace:read`, `workspace:create`, `workspace:update`, `workspace:delete`.

| Método | Rota                  | Uso                                                                         |
| ------ | --------------------- | --------------------------------------------------------------------------- |
| GET    | `/v1/workspaces`      | Workspace da chave (`data: [workspace]`); `?include=billing`                |
| POST   | `/v1/workspaces`      | Criar workspace (limite de slots → **403** `WORKSPACE_SLOTS_LIMIT_REACHED`) |
| GET    | `/v1/workspaces/{id}` | Consultar (só o workspace da chave)                                         |
| PUT    | `/v1/workspaces/{id}` | Editar nome, cor, `inboundSettingsPatch`                                    |
| DELETE | `/v1/workspaces/{id}` | Excluir (requer **≥2** workspaces na conta)                                 |

## Listar com sessão (todos os workspaces)

Com `sessionToken` de login (não API key de mensageria):

`GET /v1/platform/workspaces` — lista todos os workspaces da conta com `role` (OWNER, ADMIN, MEMBER). `?include=billing` exige `billing:read`.

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/workspaces \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Produção BR", "color": "#3B82F6" }'
```

## Billing do workspace

Plano, saldo e cartões usam rotas **Platform** com o mesmo `workspaceId`:

* `GET /v1/platform/workspaces/:id/subscription`
* `GET /v1/platform/workspaces/:id/balance`
* `GET /v1/platform/workspaces/:id/payment-methods`
* `GET /v1/platform/workspaces/:id/credits/usage` — ledger de créditos com `correlationId`, canal e chave usada (`billing:read`)

Veja [Billing](/platform-api/como-funciona/billing).

## Equipe (membros e convites)

Gerencie quem acessa o workspace via Platform API — escopos `workspace:members:read` / `workspace:members:manage`:

| Método | Rota                                            | Uso                                      |
| ------ | ----------------------------------------------- | ---------------------------------------- |
| GET    | `/v1/platform/workspaces/:id/members`           | Lista membros com role e data de entrada |
| DELETE | `/v1/platform/workspaces/:id/members/:userId`   | Remove membro                            |
| GET    | `/v1/platform/workspaces/:id/invites`           | Convites pendentes                       |
| POST   | `/v1/platform/workspaces/:id/invites`           | Convida por e-mail (`email`, `role`)     |
| DELETE | `/v1/platform/workspaces/:id/invites/:inviteId` | Cancela convite                          |

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/platform/workspaces/WORKSPACE_ID/invites \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"email": "novo@empresa.com", "role": "MEMBER"}'
```

As mesmas rotas existem em `/v1/workspaces/:id/*` com API key de mensageria (escopos de workspace).

## Trust Factor

Reputação e limites de envio: [Trust Factor](/guides/workspaces/trust-factor).

## Próximos passos

* [Introdução Platform](/platform-api/como-funciona/introducao)
* [Escopos](/platform-api/como-funciona/escopos-api-key)