Gerenciar Membros

Endpoints para listar, convidar, remover e alterar o papel de membros de uma organizacao.

---

Listar membros

Retorna todos os membros de uma organizacao.

Requisicao

GET /v1/organizations/{orgId}/members

URL completa: https://api.tapsign.com.br/v1/organizations/{orgId}/members

Headers

Header	Valor
Authorization	Bearer {token}

Parametros de rota

Parametro	Tipo	Obrigatorio	Descricao
orgId	string	Sim	ID da organizacao

Exemplo de requisicao

curl -X GET https://api.tapsign.com.br/v1/organizations/org_abc123/members \
  -H "Authorization: Bearer {token}"

Resposta

Status: 200 OK

{
  "content": [
    {
      "id": "mbr_001",
      "userId": "usr_xyz789",
      "name": "Joao Silva",
      "email": "joao@exemplo.com",
      "role": "OWNER",
      "joinedAt": "2026-01-15T10:00:00Z"
    },
    {
      "id": "mbr_002",
      "userId": "usr_abc456",
      "name": "Maria Santos",
      "email": "maria@exemplo.com",
      "role": "ADMIN",
      "joinedAt": "2026-02-20T14:30:00Z"
    },
    {
      "id": "mbr_003",
      "userId": "usr_def789",
      "name": "Pedro Oliveira",
      "email": "pedro@exemplo.com",
      "role": "MEMBER",
      "joinedAt": "2026-03-10T09:15:00Z"
    }
  ]
}

---

Convidar membro

Envia um convite por e-mail para um novo membro ingressar na organizacao.

Requisicao

POST /v1/organizations/{orgId}/members/invite

URL completa: https://api.tapsign.com.br/v1/organizations/{orgId}/members/invite

Headers

Header	Valor
Authorization	Bearer {token}
Content-Type	application/json

Parametros de rota

Parametro	Tipo	Obrigatorio	Descricao
orgId	string	Sim	ID da organizacao

Body

Campo	Tipo	Obrigatorio	Descricao
email	string	Sim	E-mail do convidado
role	string	Sim	Papel atribuido: ADMIN, MEMBER ou ID de um papel customizado

Exemplo de requisicao

curl -X POST https://api.tapsign.com.br/v1/organizations/org_abc123/members/invite \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "novo.membro@exemplo.com",
    "role": "MEMBER"
  }'

Resposta

Status: 201 Created

{
  "token": "inv_a1b2c3d4e5f6",
  "email": "novo.membro@exemplo.com",
  "role": "MEMBER",
  "invitedBy": "usr_xyz789",
  "expiresAt": "2026-04-05T14:30:00Z",
  "createdAt": "2026-03-29T14:30:00Z"
}

Expiracao do convite

Convites expiram em 7 dias. Apos esse periodo, e necessario reenviar o convite.

---

Remover membro

Remove um membro da organizacao.

Requisicao

DELETE /v1/organizations/{orgId}/members/{memberId}

URL completa: https://api.tapsign.com.br/v1/organizations/{orgId}/members/{memberId}

Headers

Header	Valor
Authorization	Bearer {token}

Parametros de rota

Parametro	Tipo	Obrigatorio	Descricao
orgId	string	Sim	ID da organizacao
memberId	string	Sim	ID do membro

Exemplo de requisicao

curl -X DELETE https://api.tapsign.com.br/v1/organizations/org_abc123/members/mbr_003 \
  -H "Authorization: Bearer {token}"

Resposta

Status: 204 No Content

Permissao necessaria

Apenas usuarios com papel OWNER ou ADMIN podem remover membros. Um ADMIN nao pode remover outro ADMIN ou o OWNER.

---

Alterar papel do membro

Atualiza o papel de um membro na organizacao.

Requisicao

PUT /v1/organizations/{orgId}/members/{memberId}/role

URL completa: https://api.tapsign.com.br/v1/organizations/{orgId}/members/{memberId}/role

Headers

Header	Valor
Authorization	Bearer {token}
Content-Type	application/json

Parametros de rota

Parametro	Tipo	Obrigatorio	Descricao
orgId	string	Sim	ID da organizacao
memberId	string	Sim	ID do membro

Body

Campo	Tipo	Obrigatorio	Descricao
role	string	Sim	Novo papel: ADMIN, MEMBER ou ID de um papel customizado

Exemplo de requisicao

curl -X PUT https://api.tapsign.com.br/v1/organizations/org_abc123/members/mbr_003/role \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "ADMIN"
  }'

Resposta

Status: 200 OK

{
  "id": "mbr_003",
  "userId": "usr_def789",
  "name": "Pedro Oliveira",
  "email": "pedro@exemplo.com",
  "role": "ADMIN",
  "joinedAt": "2026-03-10T09:15:00Z"
}

Papeis disponiveis

Papel	Descricao
OWNER	Proprietario da organizacao. Acesso total. Nao pode ser atribuido via API.
ADMIN	Administrador. Pode gerenciar membros e configuracoes.
MEMBER	Membro padrao. Acesso limitado conforme permissoes.
CUSTOM	Papel personalizado. Veja Papeis e Permissoes.

Papel OWNER

O papel OWNER nao pode ser alterado via API. A transferencia de propriedade so e possivel pelo painel da TapSign.

Erros comuns

Status	Codigo	Descricao
400	INVALID_ROLE	Papel informado e invalido
403	FORBIDDEN	Sem permissao para esta acao
404	MEMBER_NOT_FOUND	Membro nao encontrado na organizacao
409	MEMBER_ALREADY_EXISTS	Ja existe um convite pendente ou membro com esse e-mail
401	UNAUTHORIZED	Token de autenticacao invalido ou ausente