listing jobs

Endpoint do escopo de Jobs

Abaixo, temos os campos que podem servir como filtro na consulta de uma vaga

CAMPO BACKEND	OPÇÕES BACKEND	CAMPO NO FRONTEND	Observações
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/	Retorno results.id ao criar uma vaga utilizando o endpoint creating a job
code		Ao acessar a tela de gestão de vagas, é o código que fica logo abaixo do nome da vaga
name		Ao acessar a tela de gestão de vagas, é o nome da vaga em si.	Nome da vaga
status	draft, waiting_approval, approved, disapproved, published, frozen, closed, canceled	Ao acessar a tela de gestão de vagas e identificar a vaga, é a nomenclatura de status que fica logo acima do nome da vaga (podendo ser: publicada, rascunho, aprovada ,em aprovação, encerrada, cancelada, congelada, encerrada).
type	vacancy_type_apprentice vacancy_type_associate vacancy_type_talent_pool vacancy_type_effective vacancy_type_internship vacancy_type_summer vacancy_type_temporary vacancy_type_outsource vacancy_type_trainee vacancy_type_volunteer vacancy_legal_entity vacancy_type_lecturer vacancy_type_freelancer vacancy_type_autonomous	Ao acessar a tela de gestão de vagas e identificar a vaga, ao consultar as informações da vaga em, Ver Resumo -> Detalhes da vaga é o campo Tipo
publicationType	External, Internal	Na tela de gestão de vagas essa opção fica como filtro
careerPageId		No frontend aparece apenas a lista das páginas de carreiras que a empresa possui, para saber qual o Id correspondente, faça o GET utilizando o endpoint Listing carrer pages usando o nome da página de carreiras como filtro.	Retorno results.id ao utilizar o endpoint Listing carrer pages
vacancyCode		O valor colocado para cada código deposição em "Dados Internos da vaga"
roleId		Não visível	Id do cargo da vaga, criado automaticamente pela Gupy no momento da criação de um cargo.
addressState		Ao acessar a tela de gestão de vagas e identificar a vaga, ao consultar as informações da vaga em, Ver Resumo -> Local de Trabalho, campo Estado
fields			Podemos passar os valores: name, id, code e all.
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 BACKEND	CAMPO NO FRONTEND	Observações
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 (jobId)
code		Ao acessar a tela de gestão de vagas, é o código que fica logo abaixo do nome da vaga	Code da vaga
name		Ao acessar a tela de gestão de vagas, é o nome da vaga em si.	Nome da vaga
status	draft, waiting_approval, approved, disapproved, published, frozen, closed, canceled	Ao acessar a tela de gestão de vagas e identificar a vaga, é a nomenclatura de status que fica logo acima do nome da vaga (podendo ser: publicada, rascunho, aprovada ,em aprovação, encerrada, cancelada, congelada, encerrada).	Status da vaga
type	vacancy_type_apprentice vacancy_type_associate vacancy_type_talent_pool vacancy_type_effective vacancy_type_internship vacancy_type_summer vacancy_type_temporary vacancy_type_outsource vacancy_type_trainee vacancy_type_volunteer vacancy_legal_entity vacancy_type_lecturer vacancy_type_freelancer vacancy_type_autonomous	Ao acessar a tela de gestão de vagas e identificar a vaga, ao consultar as informações da vaga em, Ver Resumo -> Detalhes da vaga é o campo Tipo	Tipo da vaga
publicationType	External, Internal	Na tela de gestão de vagas essa opção fica como filtro	Tipo de publicação da vaga
numVacancies		Em resumo da vaga, na seção Detalhes da vaga	Número de posições
departmentId		Não visível	Código da área. Número gerado automaticamente pela Gupy ao criar uma área.
departmentName		Em resumo da vaga, na seção Detalhes da vaga	Nome da área
roleId		Não visível	Id do cargo. Número gerado automaticamente pela Gupy ao criar um cargo.
roleName		Em resumo da vaga, na seção Detalhes da vaga	Nome do cargo
createdAt		Não visível	Data da criação da vaga
updatedAt		Não visível	Data da última atualização da vaga
branchId		Não visível	Código da filial/estrutura organizacional gerado automaticamente na criação.
branchName			Nome da filial/estrutura organizacional

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 BACKEND	CAMPO NO FRONTEND	Observações
subsidiaryId		Não visível	Código da filial/estrutura organizacional gerado automaticamente na criação.
subsidiaryName			Nome da filial/estrutura organizacional
hiringDeadline		Ao editar uma vaga, definição de Etapas - Etapa Contratação	Data prevista para contratação
description		Em resumo da vaga a seção Descrição da vaga	Descrição da vaga
responsibilities		Em resumo da vaga a seção Descrição da vaga	Responsabilidades da vaga
prerequisites		Em resumo da vaga a seção Descrição da vaga	Pré-requisitos da vaga
additionalInformation		Em resumo da vaga a seção Descrição da vaga	Informações adicionais da vaga
notes		Dados Internos
disabilities	true, false	Em resumo da vaga a seção Detalhes da vaga	Se a vaga é também para PCD
addressStreet		Em resumo da vaga a seção Local de Trabalho	Logradouro do local de trabalho
addressNumber		Em resumo da vaga a seção Local de Trabalho	Número do local de trabalho
addressCity		Em resumo da vaga a seção Local de Trabalho	Cidade do local de trabalho
addressState		Em resumo da vaga a seção Local de Trabalho	Estado do local de trabalho
addressStateShortName		Em resumo da vaga a seção Local de Trabalho	Abreviação do nome do Estado do local de trabalho
addressCountry		Em resumo da vaga a seção Local de Trabalho	País do local de trabalho
addressCountryShortName		Em resumo da vaga a seção Local de Trabalho	Abreviação do nome do país do local de trabalho
addressZipCode		Em resumo da vaga a seção Local de Trabalho	CEP do local de trabalho
addressLatitude		Em resumo da vaga a seção Local de Trabalho	Coordenadas de latitude do local de trabalho
addressLongitude		Em resumo da vaga a seção Local de Trabalho	Coordenadas de longitude do local de trabalho
remoteWorking	true, false	Em resumo da vaga a seção Local de Trabalho	Se a vaga é remota ou não
workplaceType	hybrid, on-site, remote	Em resumo da vaga a seção Local de Trabalho	Se a vaga é remota, híbrida ou presencial
reason	staff_increase, staff_replacement	Em resumo da vaga, na seção Detalhes da vaga	Motivo da abertura da vaga
image		Ao editar uma vaga, Mídias da vaga
socialMediaImage		Ao editar uma vaga, Mídias da vaga
applicationDeadline		Na Gestão de vagas, ao localizar a vaga a informação que fica em Inscrições até	Data limite para as inscrições dentro da etapa Cadastro
careerPageId		Não visível	Número do Id da página de carreiras em que a vaga está publicada
careerPageName		Publicação da vaga	Nome da página de carreiras que a vaga está publicada
vacancyCodes		Dados Internos	Códigos de posição, se houverem
managerId		Não visível	Id do gestor responsável pela vaga
managerName		Em resumo da vaga, na seção Detalhes da vaga	Nome do gestor responsável pela vaga
managerEmail		Em resumo da vaga, na seção Detalhes da vaga	E-mail do gestor responsável pela vaga
recruiterId		Não visível	Id do recrutador responsável pela vaga
recruiterName		Em resumo da vaga, na seção Detalhes da vaga	Nome do recrutador responsável pela vaga
recruiterEmail		Em resumo da vaga, na seção Detalhes da vaga	E-mail do recrutador responsável pela vaga
salary		Em resumo da vaga, na seção Detalhes da vaga	Salário, composto pela moeda e faixa salarial
customFields		Em resumo da vaga, na seção Dados adicionais	Campos customizados e seus respectivos tipos e opções (se houver)
jobRatingCriterias			Lista de critérios de avaliação da vaga, se houver.
cancelReason	staff_increase_or_substitution_postponed, cancellation_requested_by_manager, internal_transfer, organizational_restructuring, budget_review other	Não visível	Se a vaga foi cancelada, qual o motivo
cancelReasonNotes		Não visível
cancelAt		Não visível	Se a vaga foi cancelada, quando foi
publishedAt		Na Gestão de Vagas ao localizar uma vaga temos a informação Publicada há (mostra a quantidade de dias que a vaga está como Publicada)	Se a vaga foi publicada, quando foi
closedAt		Não visível	Se a vaga foi encerrada, quando foi
approvedAt		Não visível	Se a vaga foi aprovada, quando foi
disapprovedAt		Não visível	Se a vaga não foi aprovada, quando a desaprovação ocorreu
lastFreezeDate		Não visível	Se a vaga foi congelada, a data do último congelamento
lastUnfreezeDate		Não visível	Se a vaga foi descongelada, a data do último descongelamento
creatorId		Não visível	Id do criador da vaga
creatorName		Não visível	Nome do criador da vaga
creatorEmail		Não visível	E-mail do criador da vaga
videoUrl		Mídias da vaga	URL do vídeo da página de carreiras, se houver
approvers		No resumo da vaga, a seção Quem deve avaliar os candidatos?	Mostra a lista de aprovadores quando a vaga já está com o status de APROVADA. Não sendo possível saber quando foi aprovada por cada um dos aprovadores individualmente e nem quanto tempo ficou aguardando a aprovação de um aprovador. (Válido apenas para clientes que utilizam o workflow antigo). Será descontinuado em breve.
workflowRequestMethod	all_at_once, in_order		Se foi utilizado workflow de aprovação, traz qual foi o método utilizado. (Válido apenas para clientes que utilizam o workflow antigo). Será descontinuado em breve.