Admin

Listar workspaces com uso

Lista workspaces com uso de membros e instâncias.

Chave mestra Plataforma

Exemplo de requisição

curl -X GET "https://seu-dominio/admin/tenants" \
  -H "x-api-key: $VERTICE_API_KEY"

const response = await fetch('https://seu-dominio/admin/tenants', {
  method: 'GET',
  headers: {
  'x-api-key': process.env.VERTICE_API_KEY ?? '',
  },
});

const payload = await response.json();
console.log(payload);

GET /admin/tenants

Chave mestra

Entenda

Conceituação

Lista workspaces com uso de membros e instâncias. Aceita busca por nome ou slug.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Contrato

Atributos

1 campo

Header

x-api-key string obrigatório

Chave mestra da plataforma. Não distribua a clientes.

Contrato

Resposta

200

{
  "data": {
    "id": "..."
  }
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.

401 Credencial ausente, inválida ou sessão expirada.

403 Escopo insuficiente, IP não autorizado ou workspace suspenso.