Resumes

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


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

Standard setup for AI tools providing an mcp.json file

{
  "exportacaodecandidatos-en MCP server": {
    "url": "https://apiexportacaodecandidatos.vag.as/doc/exportacaodecandidatos-en/mcp"
  }
}

GET /jobs/resumes.json

Bearer auth

The request can be made through the following parameters, which are mandatory:

Job ID (job_id); or
Date range (export_date_start e export_date_end)

Important:

The date range will fetch applicants based on the date they were moved to the export phase
The maximum range between date is 12(twelve) months

Query parameters

job_id string

Job ID.
export_date_start string(date)

Start date of applicants search.
export_date_end string(date)

End date of applicants search.
page number

requested page

Default value is 1.
per_page number

per page limit

Default value is 10.
include_additions boolean

Parameter to indicate if additions will be included in the return.

Default value is false.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id number
- nome_completo string | null
  
  Full name
- data_de_nascimento string | null
  
  Date of birth
- identidade_de_genero string | null
  
  gender identification
- cpf string | null
- email string | null
- versao_pdf string | null
  
  Resume PDF version
- pessoa_com_deficiencia boolean
  
  Person with disability
- nacionalidade string | null
  
  nationality
- telefone_celular object
  
  Cellphone
  
  Hide telefone_celular attributes Show telefone_celular attributes object
  
  ddi string | null
  
  ddd string | null
  
  number string | null
- telefone_residencial string | null
  
  Home phone It might also have small text with the number
- endereco object
  
  Address
  
  Hide endereco attributes Show endereco attributes object
  
  bairro string | null
  
  Neightborhood
  
  cep string | null
  
  ZIP code
  
  complemento string | null
  
  complement
  
  logradouro string | null
  
  address street
  
  numero string | null
  
  number
  
  pais string | null
  
  country
  
  estado string | null
  
  state
  
  cidade string | null
  
  city
  
  latitude string | null
  
  longitude string | null
- nivel_de_escolaridade string | null
  
  Education level
- autodeclaracao_racial string | null
  
  self racial declaration
- adendos object
  
  Additions can have N properties, where the attribute name defined by the addition name
  
  Hide adendos attribute Show adendos attribute object
  
  * object Additional properties
  
  Addition names can have N questions, with the attribute name defined by the question identifier name
  
  Hide * attribute Show * attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  pergunta string
  
  question
  
  resposta string
  
  answer
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- error string
- status number
404 application/json

Not Found
Hide response attributes Show response attributes object
- error string
- status number
412 application/json

Response for when any of the parameters are invalid, the return can be one or more of the values defined in the example answer
Hide response attributes Show response attributes object
- error object
  
  Hide error attributes Show error attributes object
  
  base array[string]
  
  export_date_start array[string]
  
  export_date_end array[string]
  
  job_id array[string]
  
  page array[string]
  
  per_page array[string]
- status number

GET /jobs/resumes.json

curl \
 --request GET 'https://apigateway.vagas.com.br/v1/applicants-export/jobs/resumes.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "id": 1085180,
    "nome_completo": "José Fictício Barbosa Júnior",
    "data_de_nascimento": "1967-01-23",
    "identidade_de_genero": "homem cisgênero",
    "cpf": "01234500100",
    "email": "teste@vagas.com.br",
    "versao_pdf": "string",
    "pessoa_com_deficiencia": false,
    "nacionalidade": "Brasileiro",
    "telefone_celular": {
      "ddi": "55",
      "ddd": "11",
      "number": "999999999"
    },
    "telefone_residencial": "(11) 1234-5678",
    "endereco": {
      "bairro": "string",
      "cep": "60871680",
      "complemento": "string",
      "logradouro": "Rua Iraci, 123 - Apto 7",
      "numero": "string",
      "pais": "Brasil",
      "estado": "MG",
      "cidade": "Belo Horizonte",
      "latitude": "-23.5071871",
      "longitude": "-46.8965909"
    },
    "nivel_de_escolaridade": "Formação superior completa",
    "autodeclaracao_racial": "string",
    "adendos": {
      "additionalProperty1": {
        "additionalProperty1": {
          "pergunta": "What is the correct answer?",
          "resposta": "A"
        },
        "additionalProperty2": {
          "pergunta": "What is the correct answer?",
          "resposta": "A"
        }
      },
      "additionalProperty2": {
        "additionalProperty1": {
          "pergunta": "What is the correct answer?",
          "resposta": "A"
        },
        "additionalProperty2": {
          "pergunta": "What is the correct answer?",
          "resposta": "A"
        }
      }
    }
  }
]

Response examples (401)

{
  "error": "Usuário não autenticado",
  "status": 401
}

Response examples (404)

{
  "error": "Resource not found",
  "status": 404
}

Response examples (412)

{
  "error": {
    "base": [
      "Datas devem ter intervalo máximo de 1 ano"
    ],
    "export_date_start": [
      "deve ser uma data"
    ],
    "export_date_end": [
      "deve ser uma data"
    ],
    "job_id": [
      "deve ser um numero"
    ],
    "page": [
      "deve ser maior ou igual a 1"
    ],
    "per_page": [
      "deve ser menor ou igual a 100"
    ]
  },
  "status": 412
}