Listar Organizações
Retorna as organizações ativas das quais o usuário autenticado é membro ativo. Quando a requisição usa uma chave de API, o usuário é quem criou a chave.
Listar organizações
Requisição
GET /v1/organizations
URL completa: https://api.tapsign.com.br/v1/organizations
Headers
| Header | Valor |
|---|---|
Authorization | Bearer {token} |
Exemplo de requisição
curl -X GET https://api.tapsign.com.br/v1/organizations \
-H "Authorization: Bearer {token}"
Resposta
Status: 200 OK
A resposta é uma lista simples (array), sem paginação.
[
{
"id": 42,
"name": "Empresa Exemplo LTDA",
"email": "[email protected]",
"phone": "+5511999999999",
"logoUrl": null,
"ownerId": 1001,
"maxMembers": 10,
"currentMembers": 4,
"active": true,
"createdAt": "2026-09-12T14:30:00Z"
}
]
Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | integer | Identificador da organização. É o {orgId} usado nas demais rotas. |
name | string | Nome da organização |
email | string | null | E-mail de contato da organização |
phone | string | null | Telefone da organização |
logoUrl | string | null | URL do logotipo |
ownerId | integer | ID do usuário proprietário (OWNER) |
maxMembers | integer | null | Limite de membros ativos. null indica sem limite. |
currentMembers | integer | Quantidade de membros ativos |
active | boolean | Se a organização está ativa |
createdAt | string | Data de criação (ISO 8601, UTC) |
A lista não informa o papel do usuário em cada organização. Para descobrir, consulte os membros da organização e procure o seu userId.
Criar uma organização exige plano Equipe ou Enterprise. Um usuário que não participa de nenhuma organização recebe uma lista vazia ([]).
Detalhar organização
Retorna os dados de uma organização específica.
Requisição
GET /v1/organizations/{orgId}
URL completa: https://api.tapsign.com.br/v1/organizations/{orgId}
Headers
| Header | Valor |
|---|---|
Authorization | Bearer {token} |
Parâmetros de rota
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
orgId | integer | Sim | ID da organização |
Exemplo de requisição
curl -X GET https://api.tapsign.com.br/v1/organizations/42 \
-H "Authorization: Bearer {token}"
Resposta
Status: 200 OK
O corpo é o mesmo objeto de cada item da listagem acima.
Hoje esta rota só responde para o proprietário da organização (OWNER). Para os demais membros, a API retorna 403.
Erros comuns
| Código | Quando acontece |
|---|---|
401 | Token ausente, inválido ou chave de API desativada |
403 | Em GET /v1/organizations/{orgId}: o usuário não é membro ativo da organização ou não é o proprietário |
O formato do corpo de erro está em Status de Erros.