listing applications

Endpoint do escopo de Applications

Find applications - Retorna a lista de candidaturas de uma vaga

Abaixo, temos os campos que podem servir como filtro na consulta de uma vaga, sendo o jobId o único campo obrigatório na consulta.

CAMPO BACKEND	OPÇÕES BACKEND	CAMPO NO FRONTEND	Observações
Id (jobId)		Número gerado automaticamente pela Gupy ao criar uma vaga (conhecido como jobId). Ao abrir uma vaga na plataforma, o Id pode ser identificado na URL após /companies/jobs/	Retorno results.id ao criar uma vaga utilizando o endpoint creating a job
Id (applicationId)		Número gerado automaticamente pela Gupy quando uma pessoa se candidata em uma determinada vaga. O Id aparece na URL após /jobs/jobId/candidates	Retorno results.id ao criar uma candidatura utilizando o endpoint creating an application
status	in_process, give_up, reproved, hired	Na lista de candidatos na vaga é possível ver os status logo após o nome da etapa em que o candidato está.	Status da candidatura. Quando um candidato desiste do processo ou é reprovado, além do status ele fica em um agrupamento na tela semelhante à uma etapa, porém não existe uma etapa default para desistentes ou reprovados é apenas uma visualização em tela para auxiliar quem desistiu e quem foi reprovado.
currentStep.name		Na lista de candidatos em uma vaga, o nome da etapa está logo abaixo do nome do candidato e ao abrir uma candidatura, tela principal do candidato, logo abaixo do nome.	Nome da etapa em que o candidato está no momento
candidate. identificationDocument		Ao acessar uma candidatura, aba Cadastro	CPF do candidato
vacancyCode.code		Dados da contratação	Código de posição que foi atribuído ao candidato no momento em que ele foi contratado
order	id, score, createdAt		Filtros de ordenação do retorno da busca.
fields	name, id, code e all.		Ao utilizar o fields = all todos os campos possíveis de uma candidatura vão retornar da busca.
perPage			inserir quantos itens você quer obter por página ao realizar essa consulta
page			quantidade de páginas com resultado

Se não passarmos nenhum valor ao parâmetro fields, o retorno consistirá nos seguintes campos:

CAMPO BACKEND	OPÇÕES NO BACKEND	CAMPO NO FRONTEND	Observações
id (applicationId)		Número gerado automaticamente pela Gupy quando uma pessoa se candidata em uma determinada vaga. O Id aparece na URL após /jobs/jobId/candidates	Retorno results.id ao criar uma candidatura utilizando o endpoint creating an application
partnerName	99hunters, facebook_jobs, geekhunter, glassdoor, google_for_jobs, indeed, indeed_sponsored, jooble, linkedin, netvagas, riovagas, trampos, gupy_opportunities, gupy_opportunities_recommended, gupy_public_page, gupy_public_page_event		Nome do parceiro que gerou a candidatura. Em casos de inserção manual, essa informação só é preenchida após o candidato aceitar o convite.
endedAt		Não visível	Data da desclassificação se for reprovado, data da desistência se for desistente ou contratação se for contratado. Caso o status seja "in_process" esse campo virá "null"
createdAt		Na lista de candidatos é a data que fica na coluna Inscrição	Data em que a candidatura foi criada, ou seja, quando o candidato se aplicou à vaga.
updatedAt		Não visível	Data da última atualização da candidatura.
tags		Ao acessar uma candidatura, menu de Avaliação do Candidato no lado direito da tela	Tags relacionadas à candidatura, se houverem.
candidate.birthdate		Ao acessar uma candidatura, aba Cadastro	Data de aniversário do candidato
candidate.id		Não visível	Id do candidato, gerado na primeira vez em que ele se inscreve em alguma vaga na Gupy.
candidate.name		Ao acessar uma candidatura, aba Cadastro	Nome do candidato
candidate.lastName		Ao acessar uma candidatura, aba Cadastro	Sobrenome do candidato
candidate.email		Ao acessar uma candidatura, aba Cadastro	E-mail do candidato
candidate. identificationDocument		Ao acessar uma candidatura, aba Cadastro	CPF do candidato
candidate. countryOfOrigin		Ao acessar uma candidatura, aba Cadastro	País de origem do candidato
candidate. linkedinProfileUrl		Ao abrir uma candidatura, tela principal do candidato.	URL do perfil no LinkedIn (se houver)
candidate.gender	male, female, other, notInformed	Ao acessar uma candidatura, aba Cadastro	Gênero do candidato
candidate. mobileNumber		Ao acessar uma candidatura, aba Cadastro	Telefone celular do candidato
candidate. phoneNumber		Ao acessar uma candidatura, aba Cadastro	Telefone fixo do candidato
manualCandidate		Na lista de candidatos, na coluna Características possui o símbolo de inserção manual ou acessar uma candidatura, na tela principal.	Esse objeto só terá os campos preenchidos com valor caso tenha ocorrido inserção manual do candidato.
manualCandidate.id		Não visível	Id do candidato, gerado na primeira vez em que ele se inscreve em alguma vaga na Gupy.
manualCandidate. name		Ao acessar uma candidatura, aba Inserção Manual	Nome do candidato.
manualCandidate. lastName		Ao acessar uma candidatura, aba Inserção Manual	Sobrenome do candidato.
manualCandidate. email		Ao acessar uma candidatura, aba Inserção Manual	E-mail do candidato.
manualCandidate. linkedinProfileUrl		Ao abrir uma candidatura, aba Cadastro em Perfil em redes sociais	URL do perfil no LinkedIn (se houver).
manualCandidate. mobileNumber		Ao acessar uma candidatura, aba Inserção Manual	Telefone celular do candidato.
manualCandidate. insertionSource	candidate_active_contact, events hunting, market_referral_consulting employee_referral, chrome_extension		Qual é a fonte da inserção manual do candidato
job.id		Número gerado automaticamente pela Gupy ao criar uma vaga (conhecido como jobId). Ao abrir uma vaga na plataforma, o Id pode ser identificado na URL após /companies/jobs/	Id da vaga em que essa candidatura corresponde
job.name		Ao acessar a tela de gestão de vagas, é o nome da vaga em si.	Nome da vaga que essa candidatura corresponde
currentStep.id		Não visível	Id da etapa em que o candidato está na vaga
currentStep.name		Na lista de candidatos em uma vaga, o nome da etapa está logo abaixo do nome do candidato e ao abrir uma candidatura, tela principal do candidato, logo abaixo do nome.	Nome da etapa em que o candidato está na vaga
currentStep.status
score		Na lista de candidatos em uma vaga é a porcentagem antes do nome do candidato e ao acessar uma candidatura, na tela principal é o valor definido para "Afinidade"	Aderência do candidato à vaga

Se colocarmos o valor "all" para o parâmetro fields como filtro, o retorno trará mais campos além dos que já estão na tabela acima, como mostra o exemplo abaixo:

CAMPO BACKEND	OPÇÕES NO BACKEND	CAMPO NO FRONTEND	Observações
source	google, facebook, instagram, linkedin, whatsapp, indeed, company_website, referral, university, github, telegram, other		Meio pelo qual a pessoa teve acesso à vaga
sourceOther			Ao selecionar "other" na opção acima, esse campo recebe a informação de outro meio pelo qual a pessoa teve acesso a vaga.
matching		Ao abrir uma candidatura, aba Testes	Resultado do teste de perfil realizado pelo candidato. Essa informação mostra a % de compatibilidade com a empresa.
disapprovalReason	hired_by_another_company, invited_to_another_process, missed_steps_of_process, insufficient_knowledge, hiring_not_allowed, incompatible_curriculum, gave_up_for_personal_reasons, inconsistent_admission_docs, elevated_wage_expectation, lack_of_culture_alignment, insufficient_academic_background, no_potential_for_growth, overqualified insufficient_seniority, fulfilled_vacancy, reject_at_medical_exam, candidate_outside_required_location, test_result_below_cutoff, not_respond_to_contacts, proposal_not_accepted, hired_in_another_job, lack_of_professional_experience, little_stability_in_previous_companies, medical_report_disqualified, incomplete_screening_stage, incomplete_registration_step, other_reason	Ao acessar uma candidatura, menu de Avaliação do Candidato no lado direito da tela	Caso o candidato tenha sido reprovado, ou seja o status da sua candidatura = "reproved" esse campo virá preenchido.
disapprovalReasonNotes	,		Notas adicionais sobre a reprovação de um candidato
isCompanyEmployee	true, false	Ao abrir uma candidatura, tela principal do candidato em Informações complementares	Traz a informação se o candidato é colaborador da empresa ou não (esse campo vem preenchido se a pessoa foi cadastrada como pessoa colaboradora na plataforma ou via API através do endpoint create a list of company employee
employeeEmail		Ao abrir uma candidatura, tela principal do candidato em Informações complementares	E-mail do colaborador que se candidatou a vaga
registrationComplete	true, false	Na lista de candidatos logo abaixo do nome aparece "Não iniciado" para aqueles que não completaram a etapa de cadastro	Caso o candidato tenha completado a etapa cadastro, esse campo vem true, senão, vem false.
referred	true, false	Ao abrir uma candidatura, tela principal do candidato em Informações complementares	Se o candidato informou ter sido indicado esse campo vem true, senão vem false.
referredBy		Ao abrir uma candidatura, tela principal do candidato em Informações complementares	Nome de quem indicou o candidato
referralStatus	pending, confirmed, rejected, unknown		Status da indicação (quando uma pessoa informa que foi indicada a pessoa responsável pela indicação recebe um e-mail enquanto não responder fica pendente.)
feedbackSent	true, false	Ao abrir uma candidatura aba Mensagens	Se foi enviado feedback para o candidato
hiringType	employee_admission, employee_readmission, employee_reintegration, unrelated_worker_hiring, internal_transfer	Dados da contratação	Caso o candidato tenha sido contratado (status = hired) esse campo terá algum desses valores.
hiringDate		Dados da contratação	Caso o status da candidatura seja ="hired", esse campo recebe a data da contratação
candidate.disabilities	true, false	Ao abrir uma candidatura, tela principal do candidato em Diversidade	Caso o candidato tenha informado possuir alguma deficiência esse campo vem true, caso contrário, false.
candidate. disabilityTypes	physical_disability, visual_disability, hearing_disability, mental_disability, intellectual_disability, autism_spectrum_disorder	Ao abrir uma candidatura, tela principal do candidato em Diversidade	Lista das possíveis deficiências que o candidato pode informar
candidate. addressZipCode		Ao acessar uma candidatura, aba Cadastro	CEP da residência do candidato.
candidate. addressNumber		Ao acessar uma candidatura, aba Cadastro	Número da residência do candidato.
candidate. addressStreet		Ao acessar uma candidatura, aba Cadastro	Logradouro da residência do candidato.
candidate. addressCity		Ao acessar uma candidatura, aba Cadastro	Cidade da residência do candidato.
candidate. addressState		Ao acessar uma candidatura, aba Cadastro	Estado da residência do candidato.
candidate. addressStateShortName		Ao acessar uma candidatura, aba Cadastro	Abreviação do Estado em que o candidato reside.
candidate. addressCountry		Ao acessar uma candidatura, aba Cadastro	País de residência do candidato.
candidate. addressCountryShortName		Ao acessar uma candidatura, aba Cadastro	Abreviação do nome do país em que o candidato reside.
candidate. areasOfInterest	Campo não é mais utilizado no produto	Campo não é mais utilizado no produto	Campo não é mais utilizado no produto
candidate.schooling	elementary_school, high_school, technical_course, technological, graduation, post_graduate, master_degree, phd	Ao acessar uma candidatura na tela principal	Nível escolar do candidato
candidate.schoolingStatus	complete, in_progress, incomplete	Ao acessar uma candidatura na tela principal	Status de andamento do nível escolar informado
candidate.workExperience		Ao acessar uma candidatura, aba Cadastro	Irá listar todas as experiências profissionais do candidato dentro de um array
candidate.workExperience.id		Não visível	Id da experiência profissional (cada experiência terá o seu)
candidate.workExperience.role		Ao acessar uma candidatura, aba Cadastro	Nome do cargo na experiência profissional
candidate.workExperience. companyName		Ao acessar uma candidatura, aba Cadastro	Nome da empresa da experiência profissional
candidate.workExperience. activitiesPerformed		Ao acessar uma candidatura, aba Cadastro	Atividades realizadas nessa experiência profissional
candidate.workExperience. startMonth		Ao acessar uma candidatura, aba Cadastro	Mês de início da experiência profissional
candidate.workExperience. startYear		Ao acessar uma candidatura, aba Cadastro	Ano de início da experiência profissional
candidate.workExperience. endMonth		Ao acessar uma candidatura, aba Cadastro	Mês final da experiência profissional (se não for a experiência atual, se for esse campo virá null)
candidate.workExperience. endYear		Ao acessar uma candidatura, aba Cadastro	Ano final da experiência profissional (se não for a experiência atual, se for esse campo virá null)
candidate. academicQualification		Ao acessar uma candidatura, aba Cadastro	As informações de escolaridade informadas pelo candidato virão em um array.
candidate. academicQualification.id		Não visível	Id gerado automaticamente para a formação acadêmica informada.
candidate. academicQualification.formation	elementary_school, high_school, technical_course, technological, graduation, post_graduate, master_degree, phd	Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Qual tipo de formação acadêmica o candidato possui ou está cursando
candidate. academicQualification.status	complete, in_progress, incomplete	Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Status da formação acadêmica
candidate. academicQualification.institution		Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Nome da instituição em que o candidato está realizando a sua formação acadêmica
candidate. academicQualification.course		Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Nome do curso que o candidato está cursando
candidate.academicQualification. startMonth		Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Mês de início do curso
candidate.academicQualification. startYear		Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Ano de início do curso
candidate.academicQualification. endMonth		Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Mês de conclusão do curso
candidate.academicQualification. endYear		Ao acessar uma candidatura, aba Cadastro em Grau de Instrução	Ano de conclusão do curso
candidate. languages.language	Exemplo de possíveis idiomas que podem vir no JSON: german, arabic, bengali, kazakh, chinese, korean, haitian_creole, kurdish, spanish, french, greek, hindi, hungarian, english, italian, japanese, portuguese,romanian, russian, serbo_croatian, somali, swedish	Ao acessar uma candidatura, aba Cadastro	Idioma informado pelo candidato
candidate. languages.level	basic, intermediate, advanced, fluent	Ao acessar uma candidatura, aba Cadastro	Nível de proficiência do idioma informado
additionalQuestions		Ao acessar uma candidatura, aba Cadastro	Lista de perguntas adicionais do cadastro
additionalQuestions.question		Ao acessar uma candidatura, aba Cadastro	Pergunta adicional
additionalQuestions.answer		Ao acessar uma candidatura, aba Cadastro	Resposta do candidato