Empresas- Consultar informações de um convite já enviado
Permite que seja acessado os detalhes específicos de um convite individual que foi enviado para um novo usuário da plataforma.
Funcionalidades do Endpoint:
- Visualização Detalhada: Obtenha informações completas sobre um convite específico, como:
- Identificador do Convite: Um código único que identifica o convite.
- Data de Envio: A data e hora em que o convite foi enviado.
- Status do Convite: O status atual do convite, podendo ser 'pendente', 'aceito', 'recusado' ou 'expirado'.
- Dados do Usuário Convidado: Nome, e-mail e outras informações relevantes do usuário convidado.
- Link de Convite: O link único que o usuário convidado deve acessar para se cadastrar.
- Histórico de Ações: Um registro das ações realizadas no convite, como visualização, aceitação ou recusa.
Requisição
| Campo | Tipo | Descrição | Obrigatoriedade |
|---|---|---|---|
| cnpj | Texto | CNPJ da empresa | Sim |
| client-id | Texto | Client ID enviado no Header | Sim |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Message | Texto | Mensagem de envio de convite |
| only_reference_company_name | Texto | Nome da empresa para qual foi enviado o convite |
| only_reference_company_cnpj | Texto | CNPJ para qual foi enviado o convite |
| Texto | E-mail para qual o convite foi destinado | |
| created_at | Texto | Data de criação do convite |
| link | Texto | Link enviado do convite |
| visited | Texto | Identificador se o convite foi ou não visitado |
| closed | Boleano | Convite fechado |
| converted | Boleano | Identificador se o convite foi ou não convertido |
| cnpj | Texto | CNPJ do convite enviado |
| company_name | Texto | Nome da empresa para qual o convite foi enviado |