Abler API (1.0.0)

Download OpenAPI specification:Download

Introdução

Clientes abler podem utilizar nossa API para integrar suas aplicações.

Casos de uso

Os casos de uso mais comuns dos clientes abler, incluem:

Consultorias de RH e Headhunters
- Ao ganhar um negócio em seu CRM, cadastrar automaticamente um cliente na abler;
- Ao ganhar um negócio em seu CRM, iniciar o cadastro de um processo seletivo na abler;
- Ao mover um candidato para a etapa "Contratação", cadastrar o candidato em um software de folha de pagamento;
- Ao mover um candidato para a etapa "Contratação", criar uma nova fatura no ERP com dados da negociação referente ao processo seletivo; E muito mais!
RHs corporativos
- Ao mover um candidato para a etapa "Contratação", cadastrar o candidato em um software de folha de pagamento;
- Ao mover um candidato para a etapa "Contratação", cadastrar o candidato em um software de admissão;
- Ao receber uma candidatura, cadastrar o candidato em seu WhatsApp ou ferramenta de e-mail marketing;
- Ao finalizar o processo de admissão na abler, cadastrar o candidato em um software de folha de pagamento; E muito mais!

Recursos

Clientes
- Buscar, cadastrar, atualizar e deletar clientes;
Vagas
- Buscar, cadastrar, atualizar e deletar vagas;
- Buscar e cadastrar candidatos;
Webhook
- Buscar, cadastrar, atualizar e deletar inscrições em webhooks;

Autenticação

O primeiro passo para iniciar a integração com a Abler é gerar o token de acesso. Você consegue obter o token da seguinte forma:

Acesse a conta da empresa na plataforma Abler;
Clique em "Configurações" na página de início. Se você estiver usando o novo ATS, clique em "Empresa" e precisará efetuar login novamente;
Na aba Dados da sua empresa, vá para o fim da página até chegar em "Integrações";
Crie o token e use ele na sua aplicação como descrito abaixo.

Como usar o token

Em toda requisição que realizar, envie no header da requisição:

Authorization: Bearer {COLOQUE_O_TOKEN_AQUI}

ATENÇÃO: Este token não expira. Insira-o em um lugar seguro dentro da aplicação, tais como gerenciadores de secrets ou arquivos .env. Não insira o token diretamente em seu código-fonte.

Clientes

Rotas relacionadas aos clientes de sua empresa

Buscar

Busca de clientes

Authorizations:

BearerToken

query Parameters

include	string Enum: "address" "customer_contacts" "Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o `include` separado por vírgula para retornar mais que um. Exemplo: `api.abler.com.br/v1/customers?include=address,customer_contacts`"
per_page	string Registros por página
page	string Página

Responses

Response samples

200
401
422

Content type

application/json

[{"data": [{"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
},
{"id": 2,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
}
],
"meta": {"count": 2,
"items": 2,
"page": 1,
"prev": null,
"next": null,
"last": 1
}
}
]

Criar

Criar cliente

Authorizations:

(BearerTokenAuthToken)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"customer": {"corporate_name": "Empresa SA",
"trading_name": "Empresa SA",
"cnpj": "56.577.955/0001-60",
"address_attributes": {"id": 0,
"cep": "string",
"street": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"country": "string",
"state_id": 0,
"city_id": 0,
"_destroy": true
},
"customer_contacts_attributes": [{"id": 0,
"name": "string",
"email": "string",
"role": "string",
"phone": "string",
"_destroy": true
}
]
}
}

Response samples

200
401
422

Content type

application/json

{"data": {"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
}
}

Buscar pelo id

Busca de clientes pelo id

Authorizations:

BearerToken

query Parameters

include

string

Enum: "address" "customer_contacts"

"Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o include separado por vírgula para retornar mais que um. Exemplo: api.abler.com.br/v1/customers?include=address,customer_contacts"

Responses

Response samples

200
401
404
422

Content type

application/json

[{"data": {"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
}
}
]

Atualizar

Atualizar cliente

Authorizations:

(BearerTokenAuthToken)

query Parameters

include

any

"Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o include separado por vírgula para retornar mais que um. Exemplo: api.abler.com.br/v1/customers?include=address,customer_contacts"

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"customer": {"corporate_name": "Empresa SA",
"trading_name": "Empresa SA",
"cnpj": "56.577.955/0001-60",
"address_attributes": {"id": 0,
"cep": "string",
"street": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"country": "string",
"state_id": 0,
"city_id": 0,
"_destroy": true
},
"customer_contacts_attributes": [{"id": 0,
"name": "string",
"email": "string",
"role": "string",
"phone": "string",
"_destroy": true
}
]
}
}

Response samples

200
401
422

Content type

application/json

{"data": {"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
}
}

Excluir

Excluir cliente

Authorizations:

(BearerTokenAuthToken)

query Parameters

include

any

"Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o include separado por vírgula para retornar mais que um. Exemplo: api.abler.com.br/v1/customers?include=address,customer_contacts"

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"customer": {"corporate_name": "Empresa SA",
"trading_name": "Empresa SA",
"cnpj": "56.577.955/0001-60",
"address_attributes": {"id": 0,
"cep": "string",
"street": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"country": "string",
"state_id": 0,
"city_id": 0,
"_destroy": true
},
"customer_contacts_attributes": [{"id": 0,
"name": "string",
"email": "string",
"role": "string",
"phone": "string",
"_destroy": true
}
]
}
}

Response samples

200
401
422

Content type

application/json

{"data": {"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
}
}

Vagas

Rotas relacionadas as vagas de sua empresa

Buscar

Busca de vagas

Authorizations:

BearerToken

query Parameters

q	string Busca por query string
created_at_from	string <DD/MM/YYYY> Busca data de criação da vaga
created_at_to	string <DD/MM/YYYY> Busca data de criação da vaga
forward_at_from	string <DD/MM/YYYY> Busca data de encaminhamento da vaga
forward_at_to	string <DD/MM/YYYY> Busca data de encaminhamento da vaga
finished_at_from	string <DD/MM/YYYY> Busca data de fechamento da vaga
finished_at_to	string <DD/MM/YYYY> Busca data de fechamento da vaga
released	string Enum: true false Flag para ver se a vaga está publicada ou não
statuses	string Enum: "customer_request" "draft" "waiting_approval" "ready_for_publish" "published" "stopped" "forwarded_by_customer" "finished" "canceled" Status da vaga
include	string Enum: "pipeline" "address" "team" "level_of_interest" "area_of_interests" "vacancies_benefits" "vacancies_benefits.benefit" "vacancies_languages" "vacancies_languages.language" "complementary_formations" "vacancy_admission_info" "customer" "approvers" "analysts" Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o `include` separado por vírgula para retornar mais que um. Exemplo: `api.abler.com.br/v1/vacancies?include=address,team`
per_page	string Registros por página
page	string Página

Responses

Response samples

200
401
422

Content type

application/json

[{"data": [{"id": 1,
"type": "vacancy",
"attributes": {"title": "Cargo",
"slug": "slug-vaga",
"quantity": 10,
"created_at": "2021-04-05T15:30:33.948-03:00",
"published_at": "2021-04-05T15:33:30.757-03:00",
"republished_at": "2021-04-06T11:07:58.530-03:00",
"forward_at": "2021-04-05T15:30:33.948-03:00",
"close_on": "2021-04-05T15:30:33.948-03:00",
"exclusive_pcd": false,
"description": "Descrição da vaga",
"working_journey": "Jornada de trabalho",
"released": true,
"show_progress_to_candidates": false,
"available_for_change": false,
"available_for_travel": true,
"available_for_homeoffice": true,
"refusal_reason": "Razão da não aprovação",
"educational_level": "graduacao",
"educational_level_status": "indiferente",
"cnh": "ab",
"status": "published",
"additional_info": null,
"salary": 4000,
"contracting_regime": "clt",
"quantity_hired": 2,
"experience_tags": ["Abnt",
"Administração da qualidade"
],
"work_type": ["presencial"
],
"tech_skills": ["Rails",
"Laravel"
],
"courses": ["Administração",
"Tecnologia em Sistemas para Internet"
]
},
"relationships": {"pipeline": {"data": {"id": 1,
"type": "pipeline"
}
},
"address": {"data": {"id": 1,
"type": "address"
}
},
"team": {"data": {"id": 1,
"type": "team"
}
},
"level_of_interest": {"data": {"id": 1,
"type": "level_of_interest"
}
},
"area_of_interests": {"data": [{"id": 1,
"type": "area_of_interest"
}
]
},
"vacancies_benefits": {"data": [{"id": 1,
"type": "vacancies_benefit"
}
]
},
"vacancies_languages": {"data": [{"id": 1,
"type": "vacancies_language"
}
]
},
"complementary_formations": {"data": [{"id": 1,
"type": "complementary_formation"
}
]
},
"vacancy_admission_info": {"data": {"id": 1,
"type": "vacancy_admission_info"
}
},
"customer": {"data": {"id": 1,
"type": "customer"
}
},
"approvers": {"data": [{"id": 1,
"type": "approver"
}
]
},
"analysts": {"data": [{"id": 1,
"type": "analyst"
}
]
}
}
}
],
"included": [{"id": 1,
"type": "pipeline",
"attributes": {"feedback": "Feedback",
"finished": false,
"feedback_option": "opcao feedback",
"contact_name": "Nome do contato",
"contact_email": "email@contato"
}
},
{"id": 1,
"type": "team",
"attributes": {"name": "Time"
}
},
{"id": 1,
"type": "level_of_interest",
"attributes": {"name": "Analista"
}
},
{"id": 1,
"type": "area_of_interest",
"attributes": {"name": "Tecnologia da Informação"
}
},
{"id": 1,
"type": "benefit",
"attributes": {"name": "Benefício",
"has_value": false
}
},
{"id": 1,
"type": "vacancies_benefit",
"attributes": {"extensible": false,
"value_type": "valor",
"periodicity": "mensal",
"value": 0.5
},
"relationships": {"benefit": {"data": {"id": 1,
"type": "benefit"
}
}
}
},
{"id": 1,
"type": "language",
"attributes": {"name": "Inglês"
}
},
{"id": 1,
"type": "vacancies_language",
"attributes": {"required": true,
"minimum_level": "iniciante"
},
"relationships": {"language": {"data": {"id": "19",
"type": "language"
}
}
}
},
{"id": 1,
"type": "complementary_formation",
"attributes": {"name": "Informação complementar"
}
},
{"id": 1,
"type": "address",
"attributes": {"cep": "00000-00",
"street": "Rua",
"number": 0,
"complement": "Complemento",
"neighborhood": "Bairro",
"country": "País",
"city_name": "Cidade",
"state_name": "Estado",
"state_abbreviation": "SC"
}
},
{"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
},
{"id": 1,
"type": "vacancy_admission_info",
"attributes": {"cost_center": null,
"contract_time": null,
"reason_of_demand": "Motivo",
"name_substituted": null,
"cpf_substituted": null,
"license": "ferias"
}
},
{"id": 1,
"type": "approver",
"attributes": {"email": "E-mail",
"name": "Nome",
"subdomain": null,
"role": "CEO"
}
},
{"id": 1,
"type": "analyst",
"attributes": {"name": "Nome",
"email": "E-mail",
"phone": "(41) 9999-9999",
"subdomain": null,
"active": false,
"role": "Design"
}
}
],
"meta": {"count": 1,
"items": 1,
"page": 1,
"prev": null,
"next": null,
"last": 1
}
}
]

Criar

Criar vaga

Authorizations:

(BearerTokenAuthToken)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"vacancy": {"title": "Desenvolvedor back-end",
"customer_id": 1,
"customer_contact_id": 1,
"salary": 5500,
"quantity": 1,
"contracting_regime": "aprendiz",
"working_journey": "Segunda a sexta 8:00 as 18:00",
"forward_at": "01/12/2022",
"close_on": "30/12/2022",
"exclusive_pcd": false,
"disability_ids": [1,
2,
3
],
"cnh": "a",
"seller_id": 0,
"team_id": 0,
"additional_info": "string",
"fee": 0,
"tax": 0,
"billing_info": "string",
"vacancies_benefits_attributes": [{"id": 0,
"benefit_id": 0,
"value": 0,
"value_type": "string",
"periodicity": "string",
"extensible": true,
"_destroy": true
}
],
"vacancy_admission_info_attributes": {"id": 0,
"reason_of_demand": "string",
"contract_time": "string",
"cost_center": "string",
"license": "string",
"name_substituted": "string",
"cpf_substituted": "string",
"_destroy": true
}
}
}

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "vacancy",
"attributes": {"title": "Cargo",
"slug": "slug-vaga",
"quantity": 10,
"created_at": "2021-04-05T15:30:33.948-03:00",
"published_at": "2021-04-05T15:33:30.757-03:00",
"republished_at": "2021-04-06T11:07:58.530-03:00",
"forward_at": "2021-04-05T15:30:33.948-03:00",
"close_on": "2021-04-05T15:30:33.948-03:00",
"exclusive_pcd": false,
"description": "Descrição da vaga",
"working_journey": "Jornada de trabalho",
"released": true,
"show_progress_to_candidates": false,
"available_for_change": false,
"available_for_travel": true,
"available_for_homeoffice": true,
"refusal_reason": "Razão da não aprovação",
"educational_level": "graduacao",
"educational_level_status": "indiferente",
"cnh": "ab",
"status": "published",
"additional_info": null,
"salary": 4000,
"contracting_regime": "clt",
"experience_tags": ["Abnt",
"Administração da qualidade"
],
"work_type": ["presencial"
],
"tech_skills": ["Rails",
"Laravel"
],
"courses": ["Administração",
"Tecnologia em Sistemas para Internet"
]
},
"relationships": {"pipeline": {"data": {"id": 1,
"type": "pipeline"
}
},
"address": {"data": {"id": 1,
"type": "address"
}
},
"team": {"data": {"id": 1,
"type": "team"
}
},
"level_of_interest": {"data": {"id": 1,
"type": "level_of_interest"
}
},
"area_of_interests": {"data": [{"id": 1,
"type": "area_of_interest"
}
]
},
"vacancies_benefits": {"data": [{"id": 1,
"type": "vacancies_benefit"
}
]
},
"vacancies_languages": {"data": [{"id": 1,
"type": "vacancies_language"
}
]
},
"complementary_formations": {"data": [{"id": 1,
"type": "complementary_formation"
}
]
},
"vacancy_admission_info": {"data": {"id": 1,
"type": "vacancy_admission_info"
}
},
"customer": {"data": {"id": 1,
"type": "customer"
}
},
"approvers": {"data": [{"id": 1,
"type": "approver"
}
]
},
"analysts": {"data": [{"id": 1,
"type": "analyst"
}
]
}
}
},
"included": [{"id": 1,
"type": "pipeline",
"attributes": {"feedback": "Feedback",
"finished": false,
"feedback_option": "opcao feedback",
"contact_name": "Nome do contato",
"contact_email": "email@contato"
}
},
{"id": 1,
"type": "team",
"attributes": {"name": "Time"
}
},
{"id": 1,
"type": "level_of_interest",
"attributes": {"name": "Analista"
}
},
{"id": 1,
"type": "area_of_interest",
"attributes": {"name": "Tecnologia da Informação"
}
},
{"id": 1,
"type": "benefit",
"attributes": {"name": "Benefício",
"has_value": false
}
},
{"id": 1,
"type": "vacancies_benefit",
"attributes": {"extensible": false,
"value_type": "valor",
"periodicity": "mensal",
"value": 0.5
},
"relationships": {"benefit": {"data": {"id": 1,
"type": "benefit"
}
}
}
},
{"id": 1,
"type": "language",
"attributes": {"name": "Inglês"
}
},
{"id": 1,
"type": "vacancies_language",
"attributes": {"required": true,
"minimum_level": "iniciante"
},
"relationships": {"language": {"data": {"id": "19",
"type": "language"
}
}
}
},
{"id": 1,
"type": "complementary_formation",
"attributes": {"name": "Informação complementar"
}
},
{"id": 1,
"type": "address",
"attributes": {"cep": "00000-00",
"street": "Rua",
"number": 0,
"complement": "Complemento",
"neighborhood": "Bairro",
"country": "País",
"city_name": "Cidade",
"state_name": "Estado",
"state_abbreviation": "SC"
}
},
{"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
},
{"id": 1,
"type": "vacancy_admission_info",
"attributes": {"cost_center": null,
"contract_time": null,
"reason_of_demand": "Motivo",
"name_substituted": null,
"cpf_substituted": null,
"license": "ferias"
}
},
{"id": 1,
"type": "approver",
"attributes": {"email": "E-mail",
"name": "Nome",
"subdomain": null,
"role": "CEO"
}
},
{"id": 1,
"type": "analyst",
"attributes": {"name": "Nome",
"email": "E-mail",
"phone": "(41) 9999-9999",
"subdomain": null,
"active": false,
"role": "Design"
}
}
]
}
]

Buscar pelo id

Busca de vaga pelo id

Authorizations:

BearerToken

path Parameters

id

required

integer

Vacancy id

query Parameters

include

string

Enum: "pipeline" "address" "team" "level_of_interest" "area_of_interests" "vacancies_benefits" "vacancies_benefits.benefit" "vacancies_languages" "vacancies_languages.language" "complementary_formations" "approvers" "analysts"

Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o include separado por vírgula para retornar mais que um. Exemplo: api.abler.com.br/v1/vacancies?include=address,team

Responses

Response samples

200
401
404
422

Content type

application/json

[{"data": {"id": 1,
"type": "vacancy",
"attributes": {"title": "Cargo",
"slug": "slug-vaga",
"quantity": 10,
"created_at": "2021-04-05T15:30:33.948-03:00",
"published_at": "2021-04-05T15:33:30.757-03:00",
"republished_at": "2021-04-06T11:07:58.530-03:00",
"forward_at": "2021-04-05T15:30:33.948-03:00",
"close_on": "2021-04-05T15:30:33.948-03:00",
"exclusive_pcd": false,
"description": "Descrição da vaga",
"working_journey": "Jornada de trabalho",
"released": true,
"show_progress_to_candidates": false,
"available_for_change": false,
"available_for_travel": true,
"available_for_homeoffice": true,
"refusal_reason": "Razão da não aprovação",
"educational_level": "graduacao",
"educational_level_status": "indiferente",
"cnh": "ab",
"status": "published",
"additional_info": null,
"salary": 4000,
"contracting_regime": "clt",
"experience_tags": ["Abnt",
"Administração da qualidade"
],
"work_type": ["presencial"
],
"tech_skills": ["Rails",
"Laravel"
],
"courses": ["Administração",
"Tecnologia em Sistemas para Internet"
]
},
"relationships": {"pipeline": {"data": {"id": 1,
"type": "pipeline"
}
},
"address": {"data": {"id": 1,
"type": "address"
}
},
"team": {"data": {"id": 1,
"type": "team"
}
},
"level_of_interest": {"data": {"id": 1,
"type": "level_of_interest"
}
},
"area_of_interests": {"data": [{"id": 1,
"type": "area_of_interest"
}
]
},
"vacancies_benefits": {"data": [{"id": 1,
"type": "vacancies_benefit"
}
]
},
"vacancies_languages": {"data": [{"id": 1,
"type": "vacancies_language"
}
]
},
"complementary_formations": {"data": [{"id": 1,
"type": "complementary_formation"
}
]
},
"vacancy_admission_info": {"data": {"id": 1,
"type": "vacancy_admission_info"
}
},
"customer": {"data": {"id": 1,
"type": "customer"
}
},
"approvers": {"data": [{"id": 1,
"type": "approver"
}
]
},
"analysts": {"data": [{"id": 1,
"type": "analyst"
}
]
}
}
},
"included": [{"id": 1,
"type": "pipeline",
"attributes": {"feedback": "Feedback",
"finished": false,
"feedback_option": "opcao feedback",
"contact_name": "Nome do contato",
"contact_email": "email@contato"
}
},
{"id": 1,
"type": "team",
"attributes": {"name": "Time"
}
},
{"id": 1,
"type": "level_of_interest",
"attributes": {"name": "Analista"
}
},
{"id": 1,
"type": "area_of_interest",
"attributes": {"name": "Tecnologia da Informação"
}
},
{"id": 1,
"type": "benefit",
"attributes": {"name": "Benefício",
"has_value": false
}
},
{"id": 1,
"type": "vacancies_benefit",
"attributes": {"extensible": false,
"value_type": "valor",
"periodicity": "mensal",
"value": 0.5
},
"relationships": {"benefit": {"data": {"id": 1,
"type": "benefit"
}
}
}
},
{"id": 1,
"type": "language",
"attributes": {"name": "Inglês"
}
},
{"id": 1,
"type": "vacancies_language",
"attributes": {"required": true,
"minimum_level": "iniciante"
},
"relationships": {"language": {"data": {"id": "19",
"type": "language"
}
}
}
},
{"id": 1,
"type": "complementary_formation",
"attributes": {"name": "Informação complementar"
}
},
{"id": 1,
"type": "address",
"attributes": {"cep": "00000-00",
"street": "Rua",
"number": 0,
"complement": "Complemento",
"neighborhood": "Bairro",
"country": "País",
"city_name": "Cidade",
"state_name": "Estado",
"state_abbreviation": "SC"
}
},
{"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
},
{"id": 1,
"type": "vacancy_admission_info",
"attributes": {"cost_center": null,
"contract_time": null,
"reason_of_demand": "Motivo",
"name_substituted": null,
"cpf_substituted": null,
"license": "ferias"
}
},
{"id": 1,
"type": "approver",
"attributes": {"email": "E-mail",
"name": "Nome",
"subdomain": null,
"role": "CEO"
}
},
{"id": 1,
"type": "analyst",
"attributes": {"name": "Nome",
"email": "E-mail",
"phone": "(41) 9999-9999",
"subdomain": null,
"active": false,
"role": "Design"
}
}
]
}
]

Atualizar pelo id

Atualizar vaga

Authorizations:

BearerToken

path Parameters

id

required

integer

Vacancy id

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"vacancy": {"title": "Desenvolvedor back-end",
"customer_id": 1,
"customer_contact_id": 1,
"salary": 5500,
"quantity": 1,
"contracting_regime": "aprendiz",
"working_journey": "Segunda a sexta 8:00 as 18:00",
"forward_at": "01/12/2022",
"close_on": "30/12/2022",
"exclusive_pcd": false,
"disability_ids": [1,
2,
3
],
"cnh": "a",
"seller_id": 0,
"team_id": 0,
"additional_info": "string",
"fee": 0,
"tax": 0,
"billing_info": "string",
"vacancies_benefits_attributes": [{"id": 0,
"benefit_id": 0,
"value": 0,
"value_type": "string",
"periodicity": "string",
"extensible": true,
"_destroy": true
}
],
"vacancy_admission_info_attributes": {"id": 0,
"reason_of_demand": "string",
"contract_time": "string",
"cost_center": "string",
"license": "string",
"name_substituted": "string",
"cpf_substituted": "string",
"_destroy": true
}
}
}

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "vacancy",
"attributes": {"title": "Cargo",
"slug": "slug-vaga",
"quantity": 10,
"created_at": "2021-04-05T15:30:33.948-03:00",
"published_at": "2021-04-05T15:33:30.757-03:00",
"republished_at": "2021-04-06T11:07:58.530-03:00",
"forward_at": "2021-04-05T15:30:33.948-03:00",
"close_on": "2021-04-05T15:30:33.948-03:00",
"exclusive_pcd": false,
"description": "Descrição da vaga",
"working_journey": "Jornada de trabalho",
"released": true,
"show_progress_to_candidates": false,
"available_for_change": false,
"available_for_travel": true,
"available_for_homeoffice": true,
"refusal_reason": "Razão da não aprovação",
"educational_level": "graduacao",
"educational_level_status": "indiferente",
"cnh": "ab",
"status": "published",
"additional_info": null,
"salary": 4000,
"contracting_regime": "clt",
"experience_tags": ["Abnt",
"Administração da qualidade"
],
"work_type": ["presencial"
],
"tech_skills": ["Rails",
"Laravel"
],
"courses": ["Administração",
"Tecnologia em Sistemas para Internet"
]
},
"relationships": {"pipeline": {"data": {"id": 1,
"type": "pipeline"
}
},
"address": {"data": {"id": 1,
"type": "address"
}
},
"team": {"data": {"id": 1,
"type": "team"
}
},
"level_of_interest": {"data": {"id": 1,
"type": "level_of_interest"
}
},
"area_of_interests": {"data": [{"id": 1,
"type": "area_of_interest"
}
]
},
"vacancies_benefits": {"data": [{"id": 1,
"type": "vacancies_benefit"
}
]
},
"vacancies_languages": {"data": [{"id": 1,
"type": "vacancies_language"
}
]
},
"complementary_formations": {"data": [{"id": 1,
"type": "complementary_formation"
}
]
},
"vacancy_admission_info": {"data": {"id": 1,
"type": "vacancy_admission_info"
}
},
"customer": {"data": {"id": 1,
"type": "customer"
}
},
"approvers": {"data": [{"id": 1,
"type": "approver"
}
]
},
"analysts": {"data": [{"id": 1,
"type": "analyst"
}
]
}
}
},
"included": [{"id": 1,
"type": "pipeline",
"attributes": {"feedback": "Feedback",
"finished": false,
"feedback_option": "opcao feedback",
"contact_name": "Nome do contato",
"contact_email": "email@contato"
}
},
{"id": 1,
"type": "team",
"attributes": {"name": "Time"
}
},
{"id": 1,
"type": "level_of_interest",
"attributes": {"name": "Analista"
}
},
{"id": 1,
"type": "area_of_interest",
"attributes": {"name": "Tecnologia da Informação"
}
},
{"id": 1,
"type": "benefit",
"attributes": {"name": "Benefício",
"has_value": false
}
},
{"id": 1,
"type": "vacancies_benefit",
"attributes": {"extensible": false,
"value_type": "valor",
"periodicity": "mensal",
"value": 0.5
},
"relationships": {"benefit": {"data": {"id": 1,
"type": "benefit"
}
}
}
},
{"id": 1,
"type": "language",
"attributes": {"name": "Inglês"
}
},
{"id": 1,
"type": "vacancies_language",
"attributes": {"required": true,
"minimum_level": "iniciante"
},
"relationships": {"language": {"data": {"id": "19",
"type": "language"
}
}
}
},
{"id": 1,
"type": "complementary_formation",
"attributes": {"name": "Informação complementar"
}
},
{"id": 1,
"type": "address",
"attributes": {"cep": "00000-00",
"street": "Rua",
"number": 0,
"complement": "Complemento",
"neighborhood": "Bairro",
"country": "País",
"city_name": "Cidade",
"state_name": "Estado",
"state_abbreviation": "SC"
}
},
{"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
},
{"id": 1,
"type": "vacancy_admission_info",
"attributes": {"cost_center": null,
"contract_time": null,
"reason_of_demand": "Motivo",
"name_substituted": null,
"cpf_substituted": null,
"license": "ferias"
}
},
{"id": 1,
"type": "approver",
"attributes": {"email": "E-mail",
"name": "Nome",
"subdomain": null,
"role": "CEO"
}
},
{"id": 1,
"type": "analyst",
"attributes": {"name": "Nome",
"email": "E-mail",
"phone": "(41) 9999-9999",
"subdomain": null,
"active": false,
"role": "Design"
}
}
]
}
]

Deletar pelo id

Deletar vaga pelo id

Authorizations:

BearerToken

path Parameters

id

required

integer

ID da Vaga

Responses

Response samples

200
401
404
422

Content type

application/json

[{"data": {"id": 1,
"type": "vacancy",
"attributes": {"title": "Cargo",
"slug": "slug-vaga",
"quantity": 10,
"created_at": "2021-04-05T15:30:33.948-03:00",
"published_at": "2021-04-05T15:33:30.757-03:00",
"republished_at": "2021-04-06T11:07:58.530-03:00",
"forward_at": "2021-04-05T15:30:33.948-03:00",
"close_on": "2021-04-05T15:30:33.948-03:00",
"exclusive_pcd": false,
"description": "Descrição da vaga",
"working_journey": "Jornada de trabalho",
"released": true,
"show_progress_to_candidates": false,
"available_for_change": false,
"available_for_travel": true,
"available_for_homeoffice": true,
"refusal_reason": "Razão da não aprovação",
"educational_level": "graduacao",
"educational_level_status": "indiferente",
"cnh": "ab",
"status": "published",
"additional_info": null,
"salary": 4000,
"contracting_regime": "clt",
"experience_tags": ["Abnt",
"Administração da qualidade"
],
"work_type": ["presencial"
],
"tech_skills": ["Rails",
"Laravel"
],
"courses": ["Administração",
"Tecnologia em Sistemas para Internet"
]
},
"relationships": {"pipeline": {"data": {"id": 1,
"type": "pipeline"
}
},
"address": {"data": {"id": 1,
"type": "address"
}
},
"team": {"data": {"id": 1,
"type": "team"
}
},
"level_of_interest": {"data": {"id": 1,
"type": "level_of_interest"
}
},
"area_of_interests": {"data": [{"id": 1,
"type": "area_of_interest"
}
]
},
"vacancies_benefits": {"data": [{"id": 1,
"type": "vacancies_benefit"
}
]
},
"vacancies_languages": {"data": [{"id": 1,
"type": "vacancies_language"
}
]
},
"complementary_formations": {"data": [{"id": 1,
"type": "complementary_formation"
}
]
},
"vacancy_admission_info": {"data": {"id": 1,
"type": "vacancy_admission_info"
}
},
"customer": {"data": {"id": 1,
"type": "customer"
}
},
"approvers": {"data": [{"id": 1,
"type": "approver"
}
]
},
"analysts": {"data": [{"id": 1,
"type": "analyst"
}
]
}
}
},
"included": [{"id": 1,
"type": "pipeline",
"attributes": {"feedback": "Feedback",
"finished": false,
"feedback_option": "opcao feedback",
"contact_name": "Nome do contato",
"contact_email": "email@contato"
}
},
{"id": 1,
"type": "team",
"attributes": {"name": "Time"
}
},
{"id": 1,
"type": "level_of_interest",
"attributes": {"name": "Analista"
}
},
{"id": 1,
"type": "area_of_interest",
"attributes": {"name": "Tecnologia da Informação"
}
},
{"id": 1,
"type": "benefit",
"attributes": {"name": "Benefício",
"has_value": false
}
},
{"id": 1,
"type": "vacancies_benefit",
"attributes": {"extensible": false,
"value_type": "valor",
"periodicity": "mensal",
"value": 0.5
},
"relationships": {"benefit": {"data": {"id": 1,
"type": "benefit"
}
}
}
},
{"id": 1,
"type": "language",
"attributes": {"name": "Inglês"
}
},
{"id": 1,
"type": "vacancies_language",
"attributes": {"required": true,
"minimum_level": "iniciante"
},
"relationships": {"language": {"data": {"id": "19",
"type": "language"
}
}
}
},
{"id": 1,
"type": "complementary_formation",
"attributes": {"name": "Informação complementar"
}
},
{"id": 1,
"type": "address",
"attributes": {"cep": "00000-00",
"street": "Rua",
"number": 0,
"complement": "Complemento",
"neighborhood": "Bairro",
"country": "País",
"city_name": "Cidade",
"state_name": "Estado",
"state_abbreviation": "SC"
}
},
{"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
},
{"id": 1,
"type": "vacancy_admission_info",
"attributes": {"cost_center": null,
"contract_time": null,
"reason_of_demand": "Motivo",
"name_substituted": null,
"cpf_substituted": null,
"license": "ferias"
}
},
{"id": 1,
"type": "approver",
"attributes": {"email": "E-mail",
"name": "Nome",
"subdomain": null,
"role": "CEO"
}
},
{"id": 1,
"type": "analyst",
"attributes": {"name": "Nome",
"email": "E-mail",
"phone": "(41) 9999-9999",
"subdomain": null,
"active": false,
"role": "Design"
}
}
]
}
]

Buscar candidato

Busca candidato da vaga pelo id

Authorizations:

BearerToken

path Parameters

id required	integer ID da vaga
candidate_id required	integer ID do candidato

query Parameters

include

string

Value: "candidates_pipelines"

"Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o include separado por vírgula para retornar mais que um. Exemplo: api.abler.com.br/v1/vacancies/1/candidates?include=candidates_pipelines"

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 4,
"type": "candidate",
"attributes": {"name": "Matheus",
"email": "matheus@gmail.com",
"phone": 41988889999,
"cpf": 8234355500,
"pis": 902834287283,
"birthday": "1990-01-01"
},
"relationships": {"candidates_pipelines": { }
}
}
}
]

Adicionar candidatura

Authorizations:

(BearerTokenAuthToken)

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"candidate": {"email": "candidato@gmail.com",
"name": "Nome",
"cell_phone": "string",
"cpf": "string"
}
}

Response samples

200
401
422

Content type

application/json

{"data": {"id": 4,
"type": "candidate",
"attributes": {"name": "Matheus",
"email": "matheus@gmail.com",
"phone": 41988889999,
"cpf": 8234355500,
"pis": 902834287283,
"birthday": "1990-01-01"
},
"relationships": {"candidates_pipelines": { }
}
}
}

Buscar candidatos

Busca candidatos da vaga

Authorizations:

BearerToken

path Parameters

id required	integer ID da vaga
candidate_id required	integer ID do candidato

query Parameters

per_page	string Registros por página
page	string Página
name	string Filtrar os candidatos pelo nome
email	string Filtrar os candidatos pelo e-mail
include	string Value: "candidates_pipelines" "Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o `include` separado por vírgula para retornar mais que um. Exemplo: `api.abler.com.br/v1/vacancies/1/candidates?include=candidates_pipelines`"

Responses

Response samples

200
401
422

Content type

application/json

[{"data": [{"id": 4,
"type": "candidate",
"attributes": {"name": "Matheus",
"email": "matheus@gmail.com",
"phone": 41988889999,
"cpf": 8234355500,
"pis": 902834287283,
"birthday": "1990-01-01"
},
"relationships": {"candidates_pipelines": { }
}
},
{"id": 5,
"type": "candidate",
"attributes": {"name": "Carlos",
"email": "carlos@gmail.com",
"phone": 41988887777,
"cpf": 8234355500,
"pis": 902834287283,
"birthday": "1990-01-01"
},
"relationships": {"candidates_pipelines": { }
}
}
],
"meta": {"count": 2,
"items": 2,
"page": 1,
"prev": null,
"next": null,
"last": 1
}
}
]

Coleções

Rotas relacionadas a coleções da empresa

Beneficios

Busca de beneficios

Authorizations:

BearerToken

query Parameters

q	string Busca por termos no campo nome

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "benefit",
"attributes": {"name": "Descrição do benefício",
"has_value": false
}
}
}
]

Cidades

Busca de cidades

Authorizations:

BearerToken

query Parameters

q	string Busca por termo nome
state_id	string Busca id de estado

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "city",
"attributes": {"name": "Curitiba"
}
}
}
]

Tipo de deficiência

Busca de tipo de deficiência

Authorizations:

BearerToken

query Parameters

q	string Busca por termo nome

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "disability",
"attributes": {"name": "Auditiva"
}
}
}
]

Estados

Busca de estados

Authorizations:

BearerToken

query Parameters

q	string Busca por termo nome e abreviação

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "state",
"attributes": {"name": "Paraná",
"abbreviation": "PR"
}
}
}
]

Clientes

Busca de clientes

Authorizations:

BearerToken

query Parameters

q	string Busca por termo razão social e nome fantasia

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "customer",
"attributes": {"corporate_name": "Razão social",
"trading_name": "Nome Fantasia",
"cnpj": 42434481000193,
"active": true,
"additional_info": "Informações adicionais",
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
},
"relationships": {"address": { },
"customer_contacts": { }
}
}
}
]

Contatos

Busca de contatos

Authorizations:

BearerToken

query Parameters

q	string Filtrar os contatos por query string
customer_id	integer Filtrar os contatos pelo ID do cliente
include	string Enum: "customer" "vacancies" "access_role" "Quando um relacionamento precisar estar presente no dado serializado do cliente, apenas inclua usando esse parâmetro. Envie o `include` separado por vírgula para retornar mais que um. Exemplo: `api.abler.com.br/v1/collections/customer_contacts?include=address,customer_contacts`"

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "customer_contact",
"attributes": {"name": "Customer",
"email": "customer@teste.com.br\"",
"phone": null,
"role": "CTO",
"active": true,
"allow_access": false,
"access_role_id": null,
"created_at": "2022-01-07T14:30:19.403-03:00",
"updated_at": "2022-01-07T14:30:19.403-03:00"
}
}
}
]

Usuários

Busca de usuários da empresa

Authorizations:

BearerToken

query Parameters

q	string Busca por termo nome

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "company_user",
"attributes": {"email": "company_user@teste.com.br\"",
"name": "Admin",
"phone": null,
"active": true,
"is_admin": true,
"role": true
}
}
}
]

Equipes

Busca de equipes

Authorizations:

BearerToken

query Parameters

q	string Busca por termo nome

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "team",
"attributes": {"name": "Equipe X"
}
}
}
]

Enum

Rotas relacionadas a enums da empresa

CNH

Busca de CNH

Authorizations:

BearerToken

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": "a",
"type": "cnh",
"attributes": {"name": "A"
}
}
}
]

Tipo de requisição

Busca de tipo de requisição

Authorizations:

BearerToken

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": "administracao_contrato",
"type": "requisition_type",
"attributes": {"name": "Administração de contrato"
}
}
}
]

Tipo de contrato

Busca de tipo de contrato

Authorizations:

BearerToken

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": "aprendiz",
"type": "contracting_regime",
"attributes": {"name": "Aprendiz"
}
}
}
]

Licença

Busca de licença

Authorizations:

BearerToken

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": "desligamento",
"type": "license",
"attributes": {"name": "Desligamento"
}
}
}
]

Valor de benefícios

Busca de valor de benefícios

Authorizations:

BearerToken

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": "value",
"type": "benefit_value_type",
"attributes": {"name": "Valor"
}
}
}
]

Periodicidade de benefícios

Busca de periodicidade de benefícios

Authorizations:

BearerToken

Responses

Response samples

200
401
422

Content type

application/json

[{"data": {"id": "daily",
"type": "benefit_periodicity",
"attributes": {"name": "Diário"
}
}
}
]

Webhook

Você pode se inscrever em um dos eventos disponíveis e a Abler notificará quando este evento for disparado

Use os endpoints de webhook_subscription para registrar seu endpoint;
Quando o evento for disparado, a Abler irá enviar um POST para o endpoint registrado naquele evento.

Em seguida serão exibidos a lista de eventos disponíveis.

vacancy_created Webhook

Request Body schema: application/json

Informação sobre o evento de criação de Vaga

vacancy_id	integer
event	string Value: "vacancy_created"

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"event": "vacancy_created"
}

vacancy_updated Webhook

Request Body schema: application/json

Informação sobre o evento de atualização da vaga

vacancy_id	integer
event	string Value: "vacancy_updated"

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"event": "vacancy_updated"
}

vacancy_deleted Webhook

Request Body schema: application/json

Informação sobre o evento de exclusão da vaga

vacancy_id	integer
event	string Value: "vacancy_deleted"

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"event": "vacancy_deleted"
}

candidature_created Webhook

Request Body schema: application/json

Informação sobre o evento de criação de candidatura

vacancy_id	integer
candidate_id	integer
event	string Value: "candidature_created"

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"candidate_id": 0,
"event": "candidature_created"
}

candidature_updated Webhook

Request Body schema: application/json

Informação sobre o evento de atualização de candidatura

vacancy_id	integer
candidate_id	integer
event	string Value: "candidature_updated"

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"candidate_id": 0,
"event": "candidature_updated"
}

candidature_disqualified Webhook

Request Body schema: application/json

Informação sobre o evento de desqualificação de candidato

vacancy_id	integer
candidate_id	integer
event	string Value: "candidature_disqualified"
disqualified_at	datetime

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"candidate_id": 0,
"event": "candidature_disqualified",
"disqualified_at": null
}

candidature_requalified Webhook

Request Body schema: application/json

Informação sobre o evento de requalificação de candidato

vacancy_id	integer
candidate_id	integer
event	string Value: "candidature_requalified"

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"candidate_id": 0,
"event": "candidature_requalified"
}

candidate_hired Webhook

Request Body schema: application/json

Informação sobre o evento de contratação de candidato

vacancy_id	integer
candidate_id	integer
event	string Value: "candidate_hired"
title	string
salary	float
contracting_regime	string Enum: "aprendiz" "avaliacao_psicologica" "clt" "contrato_hibrido" "estagiario" "freelancer" "intermitente" "periodo_determinado" "pj" "profissional_independente_contrato_societario" "staff" "temporario" "terceiro"
requisition_type	string Enum: "administracao_contrato" "alocacao" "banco_talentos" "expansao" "hunting" "reposicao" "substituicao"
license	string
name_substituted	string
cpf_substituted	string
contract_time	string
reason_of_demand	string
candidate_name	string
candidate_cpf	string
candidate_email	string
candidate_cell_phone	string <(00) 00000-0000>
candidate_pis	string
candidate_birthday	string <YYYY-MM-DD>
initial_date	date <YYYY-MM-DD>
address	string <Cidade/Sigla Estado>
cost_center	string
working_journey	string
additional_info	string
benefits	string
exclusive_pcd	boolean
team_name	string
customer_id	integer
customer_corporate_name	string
customer_trading_name	string
customer_cnpj	string
customer_contact_name	string
customer_cost_center_id	string
customer_cost_center_code	string
customer_cost_center_name	string
customer_cost_center_place	string

Responses

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"candidate_id": 0,
"event": "candidate_hired",
"title": "string",
"salary": null,
"contracting_regime": "aprendiz",
"requisition_type": "administracao_contrato",
"license": "string",
"name_substituted": "string",
"cpf_substituted": "string",
"contract_time": "string",
"reason_of_demand": "string",
"candidate_name": "string",
"candidate_cpf": "string",
"candidate_email": "string",
"candidate_cell_phone": "string",
"candidate_pis": "string",
"candidate_birthday": "string",
"initial_date": null,
"address": "string",
"cost_center": "string",
"working_journey": "string",
"additional_info": "string",
"benefits": "string",
"exclusive_pcd": true,
"team_name": "string",
"customer_id": 0,
"customer_corporate_name": "string",
"customer_trading_name": "string",
"customer_cnpj": "string",
"customer_contact_name": "string",
"customer_cost_center_id": "string",
"customer_cost_center_code": "string",
"customer_cost_center_name": "string",
"customer_cost_center_place": "string"
}

admission_finished Webhook

Request Body schema: application/json

Informação sobre o evento de finalização de admissão

vacancy_id	integer
candidate_id	integer
event	string Value: "admission_finished"
pipeline_stage_id	integer
name	string
email	string
cell_phone	string <(00) 00000-0000>
home_phone	string <(00) 0000-0000>
cnh	string
pis	string
cpf	string
birthday	string
gender	string
ethnicity	string
sexual_orientation	string
pronoun	string
disability	string
disability_description	string
cover_letter	string
state	string
city	string
neighborhood	string
cep	string
work_type	string
linkedin_url	string
portfolio_url	string
salary_intended	string
salary_intended_max	string
area_of_interest	Array of strings
level_of_interest	Array of strings
	Array of objects
	Array of objects

Request samples

Payload

Content type

application/json

{"vacancy_id": 0,
"candidate_id": 0,
"event": "admission_finished",
"pipeline_stage_id": 0,
"name": "string",
"email": "string",
"cell_phone": "string",
"home_phone": "string",
"cnh": "string",
"pis": "string",
"cpf": "string",
"birthday": "string",
"gender": "string",
"ethnicity": "string",
"sexual_orientation": "string",
"pronoun": "string",
"disability": "string",
"disability_description": "string",
"cover_letter": "string",
"state": "string",
"city": "string",
"neighborhood": "string",
"cep": "string",
"work_type": "string",
"linkedin_url": "string",
"portfolio_url": "string",
"salary_intended": "string",
"salary_intended_max": "string",
"area_of_interest": ["string"
],
"level_of_interest": ["string"
],
"national_experiences": [{"company": "string",
"role": "string",
"start_date": "string",
"end_date": "string",
"last_salary": "string",
"activities": "string"
}
],
"educational_profiles": [{"institution": "string",
"course": "string",
"educational_institution": "string",
"level": "string",
"start_date": "string",
"end_date": "string"
}
]
}

Buscar

Busca de subscriptions

Authorizations:

BearerToken

Responses

Response samples

200
401
422

Content type

application/json

[{"data": [{"id": 1,
"type": "webhook_subscription",
"attributes": {"event": "vacancy_created",
"url": "https://webhook.site/a679aac8-d684"
}
},
{"id": 2,
"type": "webhook_subscription",
"attributes": {"event": "vacancy_deleted",
"url": "https://webhook.site/a679aac8-d685"
}
}
],
"meta": {"count": 2,
"items": 2,
"page": 1,
"prev": null,
"next": null,
"last": 1
}
}
]

Cadastrar

Cadastrar webhook subscription

Authorizations:

BearerToken

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"webhook_subscription": {"event": "vacancy_created",
"url": "https://webhook.com.br"
}
}

Response samples

200
401
422

Content type

application/json

[{"data": {"id": 1,
"type": "webhook_subscription",
"attributes": {"event": "vacancy_created",
"url": "https://webhook.site/a679aac8-d684"
}
}
}
]

Buscar pelo id

Busca de subscription pelo id

Authorizations:

BearerToken

path Parameters

id

required

integer

Webhook Subscription id

Responses

Response samples

200
401
404
422

Content type

application/json

[{"data": {"id": 1,
"type": "webhook_subscription",
"attributes": {"event": "vacancy_created",
"url": "https://webhook.site/a679aac8-d684"
}
}
}
]

Atualizar pelo id

Atualização de subscription pelo id

Authorizations:

BearerToken

path Parameters

id

required

integer

Webhook Subscription id

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"webhook_subscription": {"event": "vacancy_created",
"url": "https://webhook.com.br"
}
}

Response samples

200
401
404
422

Content type

application/json

[{"data": {"id": 1,
"type": "webhook_subscription",
"attributes": {"event": "vacancy_created",
"url": "https://webhook.site/a679aac8-d684"
}
}
}
]

Deletar pelo id

Deletar subscription pelo id

Authorizations:

BearerToken

path Parameters

id

required

integer

Webhook Subscription id

Responses

Response samples

200
401
404
422

Content type

application/json

[{"data": {"id": 1,
"type": "webhook_subscription",
"attributes": {"event": "vacancy_created",
"url": "https://webhook.site/a679aac8-d684"
}
}
}
]