Passar para o conteúdo principal

Endpoint Vaga [POST/PUT]

W
Escrito por William Coelho

Criar vaga

[POST] https://api.quickin.io/accounts/{account_id}/jobs

Atualizar vaga

[PUT] https://api.quickin.io/accounts/{account_id}/jobs/{_id}


Autenticação

Enviar o token no header da requisição:

Authorization: Bearer {token} Content-Type: application/json

Campos principais

Campo

Tipo

Exemplo

Descrição

Limites / Observações

status

String

open

Status da vaga

Exemplo observado: open. Validar demais status disponíveis na conta/API.

publicate

String

internal

Define o tipo de publicação da vaga

Exemplo observado: internal.

openings

Number

1

Número de posições disponíveis

1–999

title

String

Estágio Help Desk / Suporte Técnico Júnior

Título da vaga

2–255 caracteres

description

String HTML

<p>Curte tecnologia...</p>

Descrição da vaga

2–4000 caracteres

requirements

String HTML

<p><strong>Requisitos obrigatórios:</strong></p>

Requisitos da vaga

2–4000 caracteres

benefits

String HTML

<p>Oferecemos bolsa...</p>

Benefícios da vaga

2–4000 caracteres

comments

String

Vaga prioritária para área de TI

Comentários internos

2–4000 caracteres

currency

String

BRL

Moeda da remuneração

Ver lista de currencies em /resources

remuneration_period

String

month

Período da remuneração

Valores comuns: hour, month, year

remuneration

Number

2000

Valor mínimo ou principal da remuneração

1–99999999

remuneration_max

Number

2500

Valor máximo negociável

1–99999999

country

String

BR

País da vaga

Ver lista de countries em /resources

region

String

São Paulo

Estado

2–60 caracteres

city

String

São Paulo

Cidade

2–60 caracteres

neighborhood

String

Jardim São Judas Tadeu

Bairro

2–60 caracteres

address

String

Rua Vitorino Nemésio

Endereço

2–100 caracteres

zipcode

String

04813140

CEP

2–60 caracteres

workplace_type

String

hybrid

Modelo de trabalho

Exemplo observado: hybrid. Validar opções disponíveis, como presencial/remoto/híbrido.

confidential

Boolean

false

Define se a vaga é confidencial

true ou false

tags

Array de String

["Prioridade alta"]

Tags associadas à vaga

Opcional

hiring_manager_name

String

William Coelho

Nome do gestor requisitante

2–60 caracteres

hiring_manager_email

String

rayssa.araujo@quickin.io

E-mail do gestor requisitante

2–60 caracteres

company_id

String

6446de626e22d8001c14f7f0

ID da empresa

Ver lista de empresas

departament_id

String

65ce3a92fdc1ac00137c2f88

ID do departamento

Ver lista de departamentos

contract_id

String

614487904d39780013ca33fc

ID do tipo de contrato

Ver lista de contratos

owner_user_id

String

69dd2e95af8cedd58e7e42ad

ID do usuário responsável pela vaga

Ver lista de usuários

experience_level

String

student_college

Nível de experiência

Ver lista em /resources

education_degree

String

bachelor_degree

Nível de escolaridade

Ver lista em /resources

position_category

String

it

Categoria da vaga

Ver lista em /resources

application_questions

Array de objetos

Ver exemplo abaixo

Perguntas adicionais da candidatura

Opcional

custom_fields

Object

{}

Campos customizados da conta

Opcional


Atenção sobre campos retornados no GET

Alguns campos aparecem no retorno da vaga, mas não devem ser enviados diretamente no POST ou PUT, pois são gerados ou controlados pela API.

Evite enviar:

{
"_id": "...",
"code": "...",
"created_at": "...",
"updated_at": "...",
"career_url": "...",
"career_url_preview": "...",
"pipeline": "...",
"deadline": "...",
"account_id": "...",
"author_user_id": "...",
"date_open": "...",
"date_close": "..."
}

Também observe que campos como company_id, departament_id, contract_id e owner_user_id podem aparecer como objetos no retorno do GET, mas no envio da criação ou atualização devem ser enviados como string com o ID.

Exemplo de retorno:

"company_id": {
"_id": "6446de626e22d8001c14f7f0",
"name": "Empresa XYZ"
}

Exemplo correto para envio:

"company_id": "6446de626e22d8001c14f7f0"

Exemplo de criação de vaga [POST]

{
"status": "open",
"publicate": "internal",
"openings": 1,
"title": "Estágio Help Desk / Suporte Técnico Júnior",
"description": "<p>Curte tecnologia, resolver problemas e falar com pessoas? Este estágio de Help Desk é a porta de entrada perfeita para sua carreira em TI.</p><p>Você vai atuar em uma equipe parceira, aprendendo na prática como funciona o suporte a usuários em um ambiente profissional.</p><ul><li>Atender chamados de suporte presencial e remoto.</li><li>Registrar e acompanhar tickets em sistema interno.</li><li>Apoiar na instalação e configuração de softwares e equipamentos.</li><li>Orientar usuários sobre uso de sistemas e ferramentas.</li><li>Escalar incidentes mais complexos para o time sênior.</li></ul>",
"requirements": "<p><strong>Requisitos obrigatórios:</strong></p><ul><li>Estar cursando graduação ou curso técnico em TI, Sistemas, Redes ou áreas correlatas.</li><li>Boa comunicação escrita e verbal em Português.</li><li>Noções básicas de sistemas operacionais Windows e pacote Office/Google Workspace.</li><li>Disponibilidade para modelo híbrido de trabalho.</li><li>Vontade genuína de aprender e atuar com atendimento ao usuário.</li><li>Inglês básico para leitura técnica.</li></ul><p><strong>Diferenciais:</strong></p><ul><li>Experiência prévia com suporte ou atendimento.</li><li>Conhecimento em redes básicas.</li><li>Noções de ITIL ou ferramentas de chamados.</li></ul>",
"benefits": "<p>Oferecemos bolsa compatível com o mercado, vale-transporte, auxílio para alimentação e contrato CLT desde o estágio. Você terá acompanhamento de mentores de TI, trilha de desenvolvimento estruturada e possibilidade real de efetivação.</p>",
"comments": "Vaga prioritária para a área de Tecnologia.",
"currency": "BRL",
"remuneration_period": "month",
"remuneration": 2000,
"remuneration_max": 2500,
"country": "BR",
"region": "São Paulo",
"city": "São Paulo",
"neighborhood": "Jardim São Judas Tadeu",
"address": "Rua Vitorino Nemésio",
"zipcode": "04813140",
"workplace_type": "hybrid",
"confidential": false,
"tags": [
"Prioridade alta"
],
"hiring_manager_name": "William Coelho",
"hiring_manager_email": "william.coelho@quickin.io",
"company_id": "6446de626e22d8001c14f7f0",
"departament_id": "65ce3a92fdc1ac00137c2f88",
"contract_id": "614487904d39780013ca33fc",
"owner_user_id": "69dd2e95af8cedd58e7e42ad",
"experience_level": "student_college",
"education_degree": "bachelor_degree",
"position_category": "it",
"application_questions": [
{
"required": true,
"type": "text",
"label": "CPF",
"options": []
}
],
"custom_fields": {}
}

Exemplo de atualização de vaga [PUT]

Para atualizar uma vaga, envie a requisição para:

PUT https://api.quickin.io/accounts/{account_id}/jobs/{_id}

Exemplo:

{
"status": "open",
"openings": 2,
"title": "Estágio Help Desk / Suporte Técnico Júnior",
"remuneration": 2200,
"remuneration_max": 2700,
"comments": "Atualização de remuneração e número de vagas.",
"tags": [
"Prioridade alta",
"TI"
]
}

Observação: em atualizações parciais, envie apenas os campos que precisam ser alterados, caso a API aceite atualização parcial. Se a API exigir payload completo, envie todos os campos obrigatórios novamente.


Dependências

Alguns campos dependem de listas auxiliares da API.

Lista de categorias, experiência, escolaridade, países e moedas

[GET] https://api.quickin.io/resources

{
"position_category": [
{
"key": "it",
"name": "Tecnologia"
}
],
"experience_level": [
{
"key": "student_college",
"name": "Estágio / Estudante"
}
],
"education_degree": [
{
"key": "bachelor_degree",
"name": "Ensino superior"
}
],
"country": [
{
"key": "BR",
"name": "Brasil"
}
],
"currency": [
{
"key": "BRL",
"name": "Brazilian Real"
}
]
}

Lista de empresas

[GET] https://api.quickin.io/accounts/{account_id}/companies?page=1

Header:

Authorization: Bearer {token}

Resposta:

{
"docs": [
{
"_id": "6446de626e22d8001c14f7f0",
"name": "Empresa XYZ",
"country": "BR",
"region": "São Paulo",
"city": "São Paulo",
"neighborhood": "...",
"address": "...",
"zipcode": "..."
}
],
"total": 1,
"limit": 30,
"page": 1,
"pages": 1
}

Lista de departamentos

[GET] https://api.quickin.io/accounts/{account_id}/departaments?page=1

Header:

Authorization: Bearer {token}

Resposta:

{
"docs": [
{
"_id": "65ce3a92fdc1ac00137c2f88",
"name": "Tecnologia"
}
],
"total": 1,
"limit": 30,
"page": 1,
"pages": 1
}

Lista de tipos de contratos

[GET] https://api.quickin.io/accounts/{account_id}/contracts?page=1

Header:

Authorization: Bearer {token}

Resposta:

{
"docs": [
{
"_id": "614487904d39780013ca33fc",
"name": "CLT"
}
],
"total": 1,
"limit": 30,
"page": 1,
"pages": 1
}

Lista de usuários

[GET] https://api.quickin.io/accounts/{account_id}/users?page=1

Header:

Authorization: Bearer {token}

Resposta:

{
"docs": [
{
"_id": "69dd2e95af8cedd58e7e42ad",
"name": "William Coelho",
"email": "william.coelho@quickin.io"
}
],
"total": 1,
"limit": 30,
"page": 1,
"pages": 1
}
Respondeu à sua pergunta?