01. VISÃO GERAL

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

  • 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}/annotations


2.1 - DADOS ENVIADOS 

Parâmetro

Descrição

Obrigatório

jobApplicationIdFiltrar pelo identificador da candidatura (integrationId ou applicant.id)(seleção)

Para retornar todas as anotações do candidatos de todas as etapas é preciso passar parâmetro jobApplicationId.


Retorno:

CampoDescrição
id

ID único da anotação

userNameNome do candidato


step

stepTypeTipo do Step que a anotação foi feita
stepNameNome do step que a anotação foi feita

annotationDate

Data da anotação

annotation

Descrição da anotação

title

Título da anotação