# Applicants Export API

> This is version `1.0.0` of this API documentation. Last update on Sep 23, 2026.
> The Applicants Export API allows Vagas for Business customers to export all candidates of a vacancy in the export phase or
> who entered the export phase in the given date range, so that they can import the data into their systems via an HTTP call in JSON format.
> 
> ## Authentication
> 
> The authentication for using this API can be done in two ways:
> 
> + Client Credencials
> + The job will be created with user identification of _admin_ as responsible
> + Autorization Code (3-legged)
> + The job will be created with the given user in the authorization steps as responsible
> 
> ### Client Credencials
> 
> This process consists of a direct POST call to the gateway indicating the credentials to obtain the access token.
> 
> Considering that the credentials were created in the gateway, just make a call according to the example:
> 
> ```
> curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://apigateway.vagas.com.br/oauth/token' --data 'grant_type=client_credentials' -u 'client_id:client_secret'
> ```
> 
> The return will be:
> 
> ```json
> {
> "access_token": "asd23sde12e123sd",
> "expires_in": 2591999,
> "token_type": "Bearer"
> }
> ```
> 
> For all other requests below, the __access\_token__ must be
> included in the request as a Authorization HEADER attribute in BEARER token format
> 
> Remembering that __access\_token__ has a time limit for use, the information returned in the key
> __expires\_in__ indicates the number of seconds that the token will expire from its generation date.
> 
> __Exemple request using the __access\_token__:__
> 
> ```shell
> # Example token the must be added in the Authorization HEADER:
> # Authorization: Bearer asd23sde12e123sd
> CURL example:
> curl -XGET <URL TBD>
> --header “Authorization: Bearer asd23sde12e123sd”
> ```
> 
> 
> ### Autorization Code (3-legged)
> 
> This process implements the OAuth 2.0 specification for authentication and authorization.
> 
> This authentication follows the "three leg" approach:
> 
> + The __remote service__ requests __user__ (Jobs For Business employee)
> to authenticate to a __VAGAS API__ server
> 
> #### How to get the token
> 
> The remote service starts the process by calling the PATH /oauth/authorize
> from the VAGAS API server, sending as parameters:
> 
> + __client_id__: Application ID (Provided by VAGAS team)
> + __login_type__: Type of login ID (must send the value "empresa")
> + __response_type__: Type of response ID (must send "code")
> + __redirect_uri__: URI that will be redirected when login action succeeds or fails
> 
> __Exemple:__
> ```
> https://apigateway.vagas.com.br/oauth/authorize?response_type=code&client_id=some_application_id&login_type=empresa&redirect_uri=http%3A%2F%2Flocalhost%2Foauth%2Fcode_callback
> ```
> 
> The user will authenticate with their credentials and authorize the use of their information
> by the remote service.
> 
> When the user accepts the authorization, the VAGAS API server will redirect back
> to the remote service using the address indicated by the redirect_uri parameter
> with an authorization code.
> 
> __Exemple:__
> ```
> http://localhost/oauth/code_callback?code=AixUbVTop239876
> ```
> 
> In case of unauthorized request, the call will be to the same URI
> informed in the redirect_uri parameter with the error parameter.
> 
> __Exemple:__
> ```
> http://localhost/oauth/code_callback?error=unauthorized-request
> ```
> 
> Using the code returned above, the remote service must request
> an access token that will be used for all other requests.
> 
> Making a new request via an HTTP POST to the route
> /oauth/token using the "application/x-www-form-urlencoded" format with the following parameters:
> + __code__: The authorization code (received in the previous request)
> + __grant_type__: Should have the value: "authorization_code"
> 
> It must also be included in the request HEADER an attribute with the client\_id and client\_secret information concatenated
> by a colon (:) and encoded in Base64
> 
> __Example:__
> 
> + Having the client\_id equal to `<client_id>` and a client\_secret equal to `<client_secret>`
> + Must be concatenated: `<client_id>:<client_secret>`
> + Applied Base64 on above value: `<base64(client_id:client_secret)>`
> + Included in the HEADER of the request: `Authorization: Basic <base64(client_id:client_secret)>`
> 
> __Exemple Curl:__
> 
> ```shell
> curl -XPOST https://apigateway.vagas.com.br/oauth/token \
> --header “Authorization: Basic <base64(client_id:client_secret)>” \
> --data “code=AixUbVTop239876&grant_type=authorization_code”
> ```
> 
> __The return of the request, if successful will be:__
> ```json
> {
> "access_token": "asd23sde12e123sd",
> "expired_in": 2591999
> }
> ```
> 
> For all other requests below, the __access\_token__ must be
> included in the request as a HEADER attribute in BEARER format
> 
> Remembering that __access\_token__ has a time limit for use, the information returned
> in the key __expires\_in__ indicates the number of seconds that the token will expire from its generation date.
> 
> __Example call using __access\_token__:__
> 
> ``` shell
> # Example value that must be included in the request HEADER:
> # Authorization: Bearer asd23sde12e123sd
> CURL example:
> curl -XGET <URL TBD>
> --header “Authorization: Bearer asd23sde12e123sd”
> ```

[Documentation](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en.md)

OpenAPI file: https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en.yaml

## MCP server

Connect AI agents to this documentation with the exportacaodecandidatos-en MCP server (Model Context Protocol, no authentication, Streamable HTTP transport):

- URL: `https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/mcp`

## [Servers](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/servers.md)
- https://apigateway.vagas.com.br/v1/applicants-export: https://apigateway.vagas.com.br/v1/applicants-export


## Topics

### [Authentication](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/authentication.md)


## Endpoints

### [Applicants resumes](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/group/endpoint-applicants-resumes.md)

- [Resumes](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/operation/operation-get_jobs_resumes_json.md)

- [PDF Resume](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/operation/operation-get_jobs_resumes_resume_id_pdf.md)




## Changelog

- [Changelog](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/changes.md)
- [Changelog index (llms.txt)](https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/changes/llms.txt)

[Powered by Bump.sh](https://bump.sh)
