Pular para o conteúdo principal

Convites

Endpoints para gerenciar convites de organizacao - aceitar, recusar, listar, cancelar e reenviar.


Listar convites pendentes (usuario)

Retorna os convites pendentes para o usuario autenticado.

Requisicao

GET /v1/invitations/pending

URL completa: https://api.tapsign.com.br/v1/invitations/pending

Headers

HeaderValor
AuthorizationBearer {token}

Exemplo de requisicao

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

Resposta

Status: 200 OK

{
"content": [
{
"token": "inv_a1b2c3d4e5f6",
"organizationId": "org_abc123",
"organizationName": "Empresa Exemplo LTDA",
"role": "MEMBER",
"invitedBy": {
"name": "Joao Silva",
"email": "joao@exemplo.com"
},
"expiresAt": "2026-04-05T14:30:00Z",
"createdAt": "2026-03-29T14:30:00Z"
}
]
}

Aceitar convite

Aceita um convite e ingressa na organizacao.

Requisicao

POST /v1/invitations/{token}/accept

URL completa: https://api.tapsign.com.br/v1/invitations/{token}/accept

Headers

HeaderValor
AuthorizationBearer {token}

Parametros de rota

ParametroTipoObrigatorioDescricao
tokenstringSimToken do convite

Exemplo de requisicao

curl -X POST https://api.tapsign.com.br/v1/invitations/inv_a1b2c3d4e5f6/accept \
-H "Authorization: Bearer {token}"

Resposta

Status: 200 OK

{
"organizationId": "org_abc123",
"organizationName": "Empresa Exemplo LTDA",
"memberId": "mbr_004",
"role": "MEMBER",
"joinedAt": "2026-03-29T15:00:00Z"
}

Recusar convite

Recusa um convite de organizacao.

Requisicao

POST /v1/invitations/{token}/decline

URL completa: https://api.tapsign.com.br/v1/invitations/{token}/decline

Headers

HeaderValor
AuthorizationBearer {token}

Parametros de rota

ParametroTipoObrigatorioDescricao
tokenstringSimToken do convite

Exemplo de requisicao

curl -X POST https://api.tapsign.com.br/v1/invitations/inv_a1b2c3d4e5f6/decline \
-H "Authorization: Bearer {token}"

Resposta

Status: 204 No Content


Listar convites enviados (organizacao)

Retorna todos os convites enviados por uma organizacao.

Requisicao

GET /v1/organizations/{orgId}/members/invitations

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

Headers

HeaderValor
AuthorizationBearer {token}

Parametros de rota

ParametroTipoObrigatorioDescricao
orgIdstringSimID da organizacao

Exemplo de requisicao

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

Resposta

Status: 200 OK

{
"content": [
{
"token": "inv_a1b2c3d4e5f6",
"email": "novo.membro@exemplo.com",
"role": "MEMBER",
"status": "PENDING",
"invitedBy": "usr_xyz789",
"expiresAt": "2026-04-05T14:30:00Z",
"createdAt": "2026-03-29T14:30:00Z"
},
{
"token": "inv_g7h8i9j0k1l2",
"email": "ana@exemplo.com",
"role": "ADMIN",
"status": "ACCEPTED",
"invitedBy": "usr_xyz789",
"expiresAt": "2026-04-01T10:00:00Z",
"createdAt": "2026-03-25T10:00:00Z"
}
]
}
Filtrar por status

Os convites retornados incluem todos os status: PENDING, ACCEPTED, DECLINED e EXPIRED. Use a lista para auditar o historico de convites da organizacao.


Cancelar convite

Cancela um convite pendente.

Requisicao

DELETE /v1/organizations/{orgId}/members/invitations/{token}

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

Headers

HeaderValor
AuthorizationBearer {token}

Parametros de rota

ParametroTipoObrigatorioDescricao
orgIdstringSimID da organizacao
tokenstringSimToken do convite

Exemplo de requisicao

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

Resposta

Status: 204 No Content


Reenviar convite

Reenvia o e-mail de convite e renova a data de expiracao.

Requisicao

POST /v1/organizations/{orgId}/members/invitations/{token}/resend

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

Headers

HeaderValor
AuthorizationBearer {token}

Parametros de rota

ParametroTipoObrigatorioDescricao
orgIdstringSimID da organizacao
tokenstringSimToken do convite

Exemplo de requisicao

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

Resposta

Status: 200 OK

{
"token": "inv_a1b2c3d4e5f6",
"email": "novo.membro@exemplo.com",
"role": "MEMBER",
"expiresAt": "2026-04-05T15:00:00Z",
"resentAt": "2026-03-29T15:00:00Z"
}
Nova expiracao

Ao reenviar o convite, a data de expiracao e renovada para mais 7 dias a partir do momento do reenvio.

Erros comuns

StatusCodigoDescricao
404INVITATION_NOT_FOUNDConvite nao encontrado
400INVITATION_EXPIREDConvite ja expirou
400INVITATION_ALREADY_ACCEPTEDConvite ja foi aceito
403FORBIDDENSem permissao para gerenciar convites
401UNAUTHORIZEDToken de autenticacao invalido ou ausente