v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Empresas

Consultar informações de um convite já enviado.

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

get/api/v1/company/find

Query parameters

cnpjstring required
Example:00.000.000/0001-00

CNPJ da empresa

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Response

Convite localizado com sucesso.

messagestring

Example response

{
  "message": "Convite localizado com sucesso."
}