01. VISÃO GERAL

Este documento apresenta os parâmetros de entrada e o retorno da API de GET de mensagens.

  • A implementação das integrações via API deve ser realizada pelo cliente, que será responsável pelos custos e pelo desenvolvimento envolvidos.

02. ENDPOINT E PARÂMETROS DE ENTRADA

Endpoint da API que será utilizado para inserir e atualizar dados:

URL baseEndpoint
https://api-centraldorecrutador.totvs.app/recruitment-integration{URL base}/api/v1/job-application/{jobApplicationId}/messages


2.1 - DADOS ENVIADOS 

Parâmetro

Descrição

Obrigatório

jobApplicationIdFiltrar pelo identificador da candidatura (integrationId ou applicant.id)(seleção)
pageNúmero da página que deseja obter os dados(erro)
pageSize

Quantidade de mensagens por páginas


(erro)


Retorno:

CampoDescrição
id

ID único da mensagem

jobApplicationIdId do candidato na candidatura
subjectAssunto da mensagem
messageTexto da mensagem
sendDate Data de envio da mensagem
recipientEmailDestinatários da mensagem




history





idId da mensagem
senderEmailRemetente do Email 
senderNameNome do remetente
messageMensagem
sendDateData do envio do email