A requisição pode ser feita através dos parâmetros a seguir, que são obrigatórios:
- ID da vaga (job_id); ou
- Intervalo de datas (export_date_start e export_date_end)
Parâmetros opcionais:
- page (se não for informado, retornará todos os registros em apenas 1 página)
- per_page (se não for informado, retornará como padrão 10 registros por página)
- include_additions (indica se os adendos serão incluidos no retorno)
Importante:
- O intervalo de datas leva em consideração a data em que o candidato foi movido para a fase de exportação
- O intervalo máximo permitido entre datas é de 12 meses
Query parameters
-
Id da vaga que será solicitados os candidatos.
-
Data de inicio para busca de candidatos.
-
Data de termino para busca de candidatos.
-
Número da página a ser retornada.
Default value is
1. -
Limite de registros para retornar por página.
Default value is
10. -
parametro para indicar se os adendos serão incluidos no retorno.
Default value is
false.
GET
/jobs/resumes.json
curl \
--request GET 'https://apigateway.vagas.com.br/v1/applicants-export/jobs/resumes.json' \
--header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
{
"id": 1085180,
"nome_completo": "José Fictício Barbosa Júnior",
"data_de_nascimento": "1967-01-23",
"identidade_de_genero": "homem cisgênero",
"documentos": [
{
"documento": "CPF (BRA)",
"pais": "Brasil",
"numero": "12345678900"
}
],
"email": "teste@vagas.com.br",
"versao_pdf": "string",
"pessoa_com_deficiencia": false,
"nacionalidade": "Brasileiro",
"telefone_celular": {
"ddi": "55",
"ddd": "11",
"number": "999999999"
},
"telefone_residencial": "(11) 1234-5678",
"endereco": {
"bairro": "string",
"cep": "60871680",
"complemento": "string",
"logradouro": "Rua Iraci, 123 - Apto 7",
"numero": "string",
"pais": "Brasil",
"estado": "MG",
"cidade": "Belo Horizonte",
"latitude": "-23.5071871",
"longitude": "-46.8965909"
},
"nivel_de_escolaridade": "Formação superior completa",
"autodeclaracao_racial": "string",
"adendos": {
"additionalProperty1": {
"additionalProperty1": {
"pergunta": "Qual a palabra certa?",
"resposta": "A"
},
"additionalProperty2": {
"pergunta": "Qual a palabra certa?",
"resposta": "A"
}
},
"additionalProperty2": {
"additionalProperty1": {
"pergunta": "Qual a palabra certa?",
"resposta": "A"
},
"additionalProperty2": {
"pergunta": "Qual a palabra certa?",
"resposta": "A"
}
}
}
}
]
Response examples (401)
{
"error": "Usuário não autenticado",
"status": 401
}
Response examples (404)
{
"error": "Resource not found",
"status": 404
}
Response examples (412)
{
"error": {
"base": [
"Datas devem ter intervalo máximo de 1 ano"
],
"export_date_start": [
"deve ser uma data"
],
"export_date_end": [
"deve ser uma data"
],
"job_id": [
"deve ser um numero"
],
"page": [
"deve ser maior ou igual a 1"
],
"per_page": [
"deve ser menor ou igual a 100"
]
},
"status": 412
}