Vagas

Criar vaga

post/jobs

Request

Base URL: https://api.inhire.app
URL: https://api.inhire.app/jobs
Auth: HTTP bearer

Headers

X-Tenantstring required

Multi-tenant identifier. Required on every request. This determines which tenant's data the request operates on. Maps to the DynamoDB partition key (tenantId).

Request body

areastring

Macro-área da vaga (engineering, product, design, etc.).

areaATSstring nullable

Área customizada do ATS para a vaga, definida pelo cliente.

competenciesstring

Competências/habilidades exigidas pela vaga (texto livre).

contractTypestring[]

Tipos de contrato aceitos pela vaga (CLT, PJ, etc.).

descriptionstring

Descrição em texto livre do recurso.

emailSequenceIdstring

Identificador da sequência de emails automatizada vinculada.

evaluatorIdsstring[]

IDs dos usuários avaliadores designados.

frameworksstring[]

Frameworks/tecnologias associadas à vaga (texto livre ou tags).

isConfidentialboolean

Quando true, a vaga é confidencial (visibilidade restrita).

languagesstring[]

Idiomas exigidos pela vaga.

locationAddressstring

Endereço (logradouro) completo do local de trabalho da vaga. Preenchido em vagas presenciais e híbridas; ignorado em vagas remotas.

locationCepstring

CEP do local de trabalho da vaga. Usado para geolocalização e exibição na divulgação; relevante apenas para vagas presenciais e híbridas.

locationCitystring

Cidade do local de trabalho. Preencha em vagas presenciais e híbridas.

locationCountrystring

País do local de trabalho (código ISO, ex. BR).

locationRequiredboolean required

Define se o candidato precisa informar a própria localização durante a inscrição. true = pedir localização ao candidato; false = não pedir.

locationStatestring

Estado/UF do local de trabalho.

locationComplementstring

Complemento do endereço (sala, andar, etc.).

locationLatitudenumber

Latitude (coordenada GPS) do local de trabalho da vaga. Usada para busca por raio e exibição no mapa da divulgação.

locationLongitudenumber

Longitude (coordenada GPS) do local de trabalho da vaga. Usada para busca por raio e exibição no mapa da divulgação.

managerIdstring

ID do usuário gestor responsável pela vaga.

namestring required

Nome/título da vaga (obrigatório).

offLimitsstring[]

Lista de empresas marcadas como off-limits para esta vaga — talentos vinculados a essas empresas não devem ser abordados/buscados como candidatos.

originstring

Origem da vaga (sistema externo que a criou, quando integrada).

originIdstring

ID externo da vaga no sistema de origem (para integrações).

recruiterIdstring

ID do usuário recrutador responsável pela vaga.

salaryCurrencystring

Moeda usada nos campos de salário da vaga (salaryMin, salaryMax, salaryTarget). Padrão BRL; aceita também USD, EUR.

salaryMaxnumber

Teto da faixa salarial da vaga.

salaryMinnumber

Piso da faixa salarial da vaga.

salaryTargetnumber

Salário-alvo da vaga. Corresponde ao campo "Salário da vaga" exibido na plataforma. Para preencher o valor que aparece na UI como "Salário da vaga", envie salaryTarget (e não salaryMin/salaryMax, que representam a faixa).

seniority'junior' | 'mid-level' | 'senior' | 'specialist' | 'leadership'

Senioridade única da vaga. Substitui o array acceptedSeniority (em descontinuação). É o campo usado pela plataforma para exibir a senioridade na divulgação e por jobBoards/dashboards customizados. Se precisar de granularidade maior para uso interno, modele em um custom field.

specialization'back-end' | 'devops' | 'front-end' | 'full-stack'

Especialização técnica (ex.: front-end, back-end).

status'canceled' | 'closed' | 'open' | 'paused'

Status atual do recurso (enum específico do domínio).

talentSuggestionsboolean required

Habilita o motor de sugestões automáticas de talentos para esta vaga (recomendações geradas a partir da base de talentos do tenant). Pode ser desligado sem efeitos colaterais.

tenantClientIdstring

ID do cliente do tenant (em tenants multi-cliente / agências). Buscar via GET /tenants/clients.

Response

Created

acceptedSenioritystring[]

Lista de senioridades aceitas pela vaga (filtro de candidaturas).

activeTalentsnumber

Quantidade de candidatos ativos na vaga.

Macro-área da vaga (engineering, product, design, etc.).

areaATSstring nullable

Área customizada do ATS para a vaga, definida pelo cliente.

competenciesstring

Competências/habilidades exigidas pela vaga (texto livre).

contractTypestring[]

Tipos de contrato aceitos pela vaga (CLT, PJ, etc.).

createdAtstring required

Timestamp ISO-8601 de criação do recurso.

descriptionstring

Descrição em texto livre do recurso.

emailSequenceIdstring

Identificador da sequência de emails automatizada vinculada.

evaluatorIdsstring[]

IDs dos usuários avaliadores designados.

filteringJobTalentsBySearchEngineboolean

Indica se a listagem de candidatos da vaga usa o motor de busca Typesense em vez de scan direto.

frameworksstring[]

Frameworks/tecnologias associadas à vaga (texto livre ou tags).

hirednumber

Quantidade de talentos contratados (status hired) nesta vaga. Contador agregado atualizado pelo processamento de eventos de candidatura.

idstring required

Identificador único do recurso (ULID).

isConfidentialboolean

Quando true, a vaga é confidencial (visibilidade restrita).

isTalentPoolboolean

Flag booleana de domínio (ver campo equivalente nos types TS).

languagesstring[]

Idiomas exigidos pela vaga.

locationAddressstring

Endereço (logradouro) completo do local de trabalho da vaga. Preenchido em vagas presenciais e híbridas; ignorado em vagas remotas.

locationCepstring

CEP do local de trabalho da vaga. Usado para geolocalização e exibição na divulgação; relevante apenas para vagas presenciais e híbridas.

locationCitystring

Cidade declarada na localização da vaga ou do talento.

locationComplementstring

Complemento do endereço (sala, andar, etc.).

locationCountrystring

País declarado na localização (código ISO 3166-1 alpha-2).

locationLatitudenumber

Latitude (coordenada GPS) do local de trabalho da vaga. Usada para busca por raio e exibição no mapa da divulgação.

locationLongitudenumber

Longitude (coordenada GPS) do local de trabalho da vaga. Usada para busca por raio e exibição no mapa da divulgação.

locationRequiredboolean required

Define se o candidato precisa informar a própria localização durante a inscrição. true = pedir localização ao candidato; false = não pedir.

locationStatestring

Estado/UF declarado na localização (sigla).

managerIdstring

Identificador(es) de manager.

namestring required

Nome legível do recurso.

offLimitsstring[]

Lista de empresas marcadas como off-limits para esta vaga — talentos vinculados a essas empresas não devem ser abordados/buscados como candidatos.

openPositionsnumber

Quantidade de posições ainda em aberto para a vaga (i.e. posições não preenchidas/canceladas).

originIdstring

Identificador(es) de origin.

recruiterIdstring

Identificador(es) de recruiter.

salaryCurrencystring

Moeda usada nos campos de salário da vaga (salaryMin, salaryMax, salaryTarget). Padrão BRL; aceita também USD, EUR.

salaryMaxnumber

Faixa salarial máxima oferecida pela vaga (na moeda do currency).

salaryMinnumber

Faixa salarial mínima oferecida pela vaga (na moeda do currency).

salaryTargetnumber

Salário-alvo para a vaga (referência interna).

seniority'junior' | 'mid-level' | 'senior' | 'specialist' | 'leadership'

Senioridade principal da vaga.

specializationobject required

Especialização técnica (ex.: front-end, back-end).

status'canceled' | 'closed' | 'open' | 'paused' | 'pending' required

Status atual do recurso (enum específico do domínio).

talentSuggestionsboolean required

Habilita o motor de sugestões automáticas de talentos para esta vaga (recomendações geradas a partir da base de talentos do tenant). Pode ser desligado sem efeitos colaterais.

talentsCountnumber

Contagem agregada (ver handler para definição exata da métrica).

tenantClientIdstring

Identificador externo do cliente do tenant (ID do cliente B2B configurado pelo tenant).

updatedAtstring required

Timestamp ISO-8601 da última atualização do recurso.

userGroupsstring[] nullable

Lista de IDs dos grupos (teams) aos quais o usuário pertence.

userIdstring nullable required

Identificador do usuário associado ao recurso.

userNamestring required

Nome de exibição do usuário associado ao registro.

Changes

No recorded changes to this operation across all 1 revision of this API.