01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de GET de candidatura.
IMPORTANTE
- 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 base | Endpoint |
|---|---|
| https://api-centraldorecrutador.totvs.app/recruitment-integration | {URL base}/api/v1/job-application/search |
2.1 - DADOS ENVIADOS
Parâmetro | Descrição | Obrigatório |
|---|---|---|
| jobOpportunityStatus | Filtrar pelo status da vaga , com as seguintes opções:
|
|
| jobApplicationStatus | Filtrar pelo status da candidatura (Padrão é status Contratado), com as seguintes opções:
|
|
| jobApplicationId | Filtrar pelo identificador da candidatura (integrationId ou applicant.id) |  |
| jobApplicationChangeStatus | Filtrar para pegar todos os candidatos com data de alteração posterior a informada | |
| page | Número da página que deseja obter os dados | |
| order | Ordem que os registros serão retornados. Exemplo:
|
|
Para retornar todos os candidatos de todas as etapas é preciso passar parâmetro All para os filtros jobApplicationStatus e jobOpportunityStatus
O número máximo de pessoas candidatas por página é de 100.
Retorno:
| Campo | Descrição | ||
|---|---|---|---|
| integrationId | ID único de integração | ||
| hiringDate | Data de contratação | ||
| fullName | Nome do candidato | ||
| socialName | Nome Social | ||
applicant | id | Código da candidatura | |
| cpf | CPF do candidato | ||
| E-mail do candidato | |||
| birthday | Data de nascimento | ||
| telephoneNumber | Telefone | ||
address | zipCode | CEP | |
| cityName | Cidade | ||
| stateName | Estado | ||
| stateSmallName | Estado Abreviado | ||
| street | Rua | ||
| complement | Complemento | ||
| neighborhoodName | Bairro | ||
| gender | Sexo | ||
| genderIdentity | Identidade de Gênero | ||
| pronoun | Pronomes | ||
diversity | physical | Deficiência Física | |
| visual | Deficiência visual | ||
| auditory | Deficiência auditiva | ||
| intellectual | Deficiência intelectual | ||
| multiple | Deficiência múltipla | ||
| autismSpectrum | Possui autismo | ||
jobOpportunity | code | Código da vaga ATS | |
| internalClientCode | Código da vaga | ||
| erpRequisitionIntegrationId | Código de requisição vinculada a vaga (integrada com ERP) | ||
| title | Título da vaga | ||
| isTalentBank | Tipo Banco de talentos | ||
| isInternal | Tipo Interna | ||
| isExternal | Tipo Externa | ||
| jobOpportunityType | Lista dos tipos da vaga | ||
| invitationLanguage | Idioma do convite | ||
facility | name | Nome unidade (Filial) | |
| cnpj | CNPJ unidade | ||
| stateSmallName | Estado (UF) | ||
| cityName | Cidade | ||
| stateName | Estado | ||
| integrationId | Código unidade (interno ERP) | ||
department | name | Nome da área/departamento | |
| integrationId | Código da área/departamento (interno ERP) | ||
| position | name | Nome do cargo | |
| integrationId | Código do cargo (interno ERP) | ||
| isCLT | Regime de contratação CLT | ||
| isPJ | Regime de contratação Pessoa jurídica | ||
| IsInternship | Regime de contratação Estágio | ||
| isFreelancer | Regime de contratação Freelancer | ||
| isCooperated | Regime de contratação Cooperado | ||
| responsibleUser | Recrutador responsável | ||
request | type | Tipo da requisição | |
| code | Código da requisição | ||
| justification | Justificativa da requisição | ||
currentStep | stepId | Id etapa atual | |
| stepType | Tipo etapa atual | ||
| name | Nome etapa atual | ||
| startDate | Data inicio etapa atual | ||
| endDate | Data fim etapa atual | ||
stepHistory | stepId | Id etapas anteriores | |
| stepType | Tipo etapas anteriores | ||
| name | Nome etapas anteriores | ||
| startDate | Data inicio etapas anteriores | ||
| endDate | Data fim etapa anteriores | ||
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas