InHire API

https://docs.inhire.com.br/api
Admin
The InHire API provides programmatic access to manage users, job postings, candidates, applications,...
Tokens:45,390
Snippets:195
Trust Score:9
Update:6 months ago
Show doc for...
Tokens:
Raw
### cURL Example for Creating Requisition

Source: https://docs.inhire.com.br/api/criar-requisicao

Example of how to create a requisition using cURL. This includes the endpoint, headers, and the raw JSON data.

```curl
curl -L 'https://api.inhire.app/requisitions/' \
-H 'Content-Type: application/json' \
--data-raw '{
  "name": "Requisição para Desenvolvedores Frontend",
  "approvers": [
    {
      "name": "João da Silva",
      "email": "joao.da.silva@email.com"
    }
  ],
  "description": "Requisição para Desenvolvedores Frontend",
  "positions": [
    {
      "reason": "replacement"
    }
  ],
  "salaryMin": 8000,
  "salaryMax": 12000,
  "contractType": "CLT"
}'
```

--------------------------------

### GET tenants/clients

Source: https://docs.inhire.com.br/api/obter-clientes

Endpoint para recuperar a lista de clientes de um tenant.

```APIDOC
## GET tenants/clients

### Description
Obtém os clientes de um tenant.

### Method
GET

### Endpoint
tenants/clients

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Bearer token de autorização para validar o acesso.

### Response
#### Success Response (200)
- **id** (string) - Identificador do cliente
- **name** (string) - Nome do cliente
- **tenantId** (string) - Identificador do tenant
- **status** (string) - Status do cliente
- **cnpj** (string) - CNPJ do cliente
- **site** (string) - Site do cliente
- **linkedin** (string) - Perfil do LinkedIn
- **logo** (string) - URL da logo
- **contacts** (object[]) - Lista de contatos
  - **name** (string) - Nome do contato
  - **phone** (string) - Telefone do contato
  - **email** (string) - E-mail do contato
- **createdAt** (date-time) - Data de criação
- **updatedAt** (date-time) - Data de atualização
```

--------------------------------

### GET /requisitions/paginated

Source: https://docs.inhire.com.br/api/listar-requisicoes

Recupera uma lista de requisições de forma paginada.

```APIDOC
## GET /requisitions/paginated

### Description
Retorna uma lista de requisições de contratação com suporte a paginação.

### Method
GET

### Endpoint
https://api.inhire.app/requisitions/paginated

### Parameters
#### Query Parameters
- **lastEvaluatedKey** (string) - Optional - Chave para paginação de resultados.

### Response
#### Success Response (200)
- **lastEvaluatedKey** (string) - Chave para a próxima página.
- **results** (object[]) - Lista de requisições contendo detalhes como id, name, description, status, positions, salaryMin, salaryMax e approvalWorkflow.
```

--------------------------------

### cURL Login Request

Source: https://docs.inhire.com.br/api/login

Example of how to make a login request using cURL. Ensure to replace {{email}} and {{password}} with actual credentials.

```curl
curl -L 'https://auth.inhire.app/login' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "email": "{{email}}",
  "password": "{{password}}"
}'
```

--------------------------------

### GET /forms/scorecards/interviews

Source: https://docs.inhire.com.br/api/obter-todos-os-kits-de-entrevista

Retrieves all interview kits. Requires an Authorization header.

```APIDOC
## GET /forms/scorecards/interviews

### Description
Obtem todos os Kits de Entrevista.

### Method
GET

### Endpoint
/forms/scorecards/interviews

### Parameters
#### Header Parameters
- **Authorization** (string) - REQUIRED - Header for authentication.

### Responses
#### Success Response (200)
- **Kits de Entrevista** (object[]) - OPTIONAL - Kits de Entrevista obtidos com sucesso
  - **jobId** (string) - OPTIONAL
  - **skillCategories** (object[]) - OPTIONAL
    - **name** (string) - OPTIONAL
  - **skills** (object[]) - OPTIONAL
    - **name** (string) - OPTIONAL
  - **visible** (boolean) - OPTIONAL
  - **script** (string) - OPTIONAL
  - **jobStageId** (string) - OPTIONAL
  - **name** (string) - OPTIONAL
  - **userName** (string) - OPTIONAL
  - **userId** (string) - OPTIONAL
  - **tenantId** (string) - OPTIONAL
  - **id** (string) - OPTIONAL
  - **createdAt** (string) - OPTIONAL
  - **updatedAt** (string) - OPTIONAL

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response Example
```json
{
  "jobId": "string",
  "skillCategories": [
    {
      "name": "string"
    }
  ],
  "skills": [
    {
      "name": "string"
    }
  ],
  "visible": true,
  "script": "string",
  "jobStageId": "string",
  "name": "string",
  "userName": "string",
  "userId": "string",
  "tenantId": "string",
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
```
```

--------------------------------

### Exemplo de Requisição Node.js

Source: https://docs.inhire.com.br/api/obter-pagina-de-carreira

Exemplo de como chamar o endpoint `GET /job-posts/public/pages` utilizando Node.js. O header `X-Tenant` é obrigatório e deve ser configurado corretamente.

```javascript
const axios = require('axios');

const tenantId = 'seu-tenant-id'; // Substitua pelo seu Tenant ID
const customFieldIds = 'customField1,customField2'; // Opcional

axios.get('https://api.inhire.app/job-posts/public/pages', {
  headers: {
    'X-Tenant': tenantId,
    'Accept': 'application/json'
  },
  params: {
    customFieldIds: customFieldIds
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching career page:', error);
});
```

--------------------------------

### Exemplo de Requisição Python

Source: https://docs.inhire.com.br/api/obter-pagina-de-carreira

Exemplo de como chamar o endpoint `GET /job-posts/public/pages` utilizando Python com a biblioteca `requests`. Lembre-se de incluir o header `X-Tenant`.

```python
import requests

tenant_id = 'seu-tenant-id'  # Substitua pelo seu Tenant ID
custom_field_ids = 'customField1,customField2'  # Opcional

url = 'https://api.inhire.app/job-posts/public/pages'

headers = {
    'X-Tenant': tenant_id,
    'Accept': 'application/json'
}

params = {
    'customFieldIds': custom_field_ids
}

try:
    response = requests.get(url, headers=headers, params=params)
    response.raise_for_status()  # Levanta um erro para códigos de status ruins (4xx ou 5xx)
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f'Error fetching career page: {e}')
```

--------------------------------

### GET /talents

Source: https://docs.inhire.com.br/api/listar-talentos

Retrieves a list of talents available in the system.

```APIDOC
## GET /talents

### Description
Retrieves a list of talents from the InHire platform.

### Method
GET

### Endpoint
https://api.inhire.app/talents

### Response
#### Success Response (200)
- **getTalents** (object) - Returns a list of talents.

#### Response Example
```json
{
  "talents": []
}
```
```

--------------------------------

### GET tenants/clients/:id

Source: https://docs.inhire.com.br/api/obter-cliente-por-id

Retrieves the details of a specific client by providing their unique ID.

```APIDOC
## GET tenants/clients/:id

### Description
Returns the details of a specific client identified by the provided ID.

### Method
GET

### Endpoint
https://api.inhire.app/tenants/clients/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the client.

### Response
#### Success Response (200)
- **id** (string) - Client ID
- **name** (string) - Client name
- **logo** (string) - Client logo URL
- **contacts** (object[]) - List of contact objects
  - **name** (string) - Contact name
  - **phone** (string) - Contact phone number
  - **email** (string) - Contact email address
- **createdAt** (date-time) - Creation timestamp
- **updatedAt** (date-time) - Last update timestamp

#### Response Example
{
  "id": "string",
  "name": "string",
  "logo": "string",
  "contacts": [
    {
      "name": "string",
      "phone": "string",
      "email": "string"
    }
  ],
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}
```

--------------------------------

### List Talents

Source: https://docs.inhire.com.br/api/listar-talentos

Use this endpoint to retrieve a list of all talents. Requires a GET request to the /talents path.

```http
GET /talents
```

```curl
curl -L 'https://api.inhire.app/talents'
```

--------------------------------

### Exemplo de Requisição cURL

Source: https://docs.inhire.com.br/api/obter-pagina-de-carreira

Exemplo de como chamar o endpoint `GET /job-posts/public/pages` utilizando cURL. Certifique-se de incluir o header `X-Tenant` com o identificador do seu Tenant.

```curl
curl -L 'https://api.inhire.app/job-posts/public/pages' \
-H 'Accept: application/json'
```

--------------------------------

### Duplicate Job cURL Example

Source: https://docs.inhire.com.br/api/duplicar-vaga

This cURL command demonstrates how to send a POST request to duplicate a job. Ensure to replace placeholder values with your actual job data.

```curl
curl -L 'https://api.inhire.app/jobs/duplicate' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{ 
  "duplicateFrom": {
    "id": "string",
    "name": "string"
  },
  "duplication": {
    "tags": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "subscriptionForms": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "testForms": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "diversity": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "workflows": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "scorecard": {
      "checked": true,
      "options": {
        "active": true
      }
    }
  },
  "name": "string",
  "positions": [
    {
      "reason": "expansion"
    }
  ],
  "requisitions": [
    {
      "id": "string",
      "positions": [
        {
          "reason": "expansion"
        }
      ]
    }
  ]
}'
```

--------------------------------

### POST /jobs/paginated/lean

Source: https://docs.inhire.com.br/api/obter-vagas-paginadas

Retrieves a paginated list of job openings. Supports pagination using an exclusive start key and a limit parameter.

```APIDOC
## POST /jobs/paginated/lean

### Description
This endpoint returns job openings in a paginated format. It allows defining the number of jobs to return and the starting point for pagination using a job identifier.

### Method
POST

### Endpoint
/jobs/paginated/lean

### Parameters
#### Request Body
- **exclusiveStartKey** (object) - Optional - Identifier that marks where the job listing should start. Contains `id` (string) and `tenantId` (string).
- **tenantId** (string) - Required - The tenant identifier.
- **limit** (number) - Optional - Maximum number of jobs to display per page. Default is 10.

### Request Example
{
  "exclusiveStartKey": {
    "id": "{{id}}",
    "tenantId": "{{tenantId}}"
  },
  "limit": 10
}

### Response
#### Success Response (200)
- **results** (object[]) - List of returned jobs.
- **startKey** (object) - Identifier that marks the start of the next page of jobs.

#### Response Example
{
  "results": [
    {
      "id": "job_123",
      "name": "Software Engineer",
      "status": "open"
    }
  ],
  "startKey": {
    "id": "job_123",
    "tenantId": "tenant_abc"
  }
}
```

--------------------------------

### Definição do endpoint de URL assinada

Source: https://docs.inhire.com.br/api/obter-url-assinada

Estrutura do caminho para a requisição GET de assinatura de arquivos.

```text
GET files/signature/:category/:name
```

--------------------------------

### GET /job-posts/public/pages

Source: https://docs.inhire.com.br/api/obter-pagina-de-carreira

Use este endpoint para recuperar a página de carreira default com as vagas publicadas. Opcionalmente, inclua `customFieldIds` para especificar quais campos customizados de vaga devem ser retornados.

```http
GET /job-posts/public/pages
```

--------------------------------

### Obter Clientes - Endpoint

Source: https://docs.inhire.com.br/api/obter-clientes

Endpoint para a requisição GET de clientes. Requer um token de autorização no cabeçalho.

```http
GET tenants/clients
```

--------------------------------

### Obter tags de uma vaga via GET

Source: https://docs.inhire.com.br/api/obter-tags-de-uma-vaga

Endpoint para recuperar tags de uma vaga específica utilizando o jobId.

```http
GET /jobs/:jobId/tags
```

--------------------------------

### Endpoint de consulta de candidatura

Source: https://docs.inhire.com.br/api/obter-candidaturas-de-um-talento

Define a estrutura da requisição GET para o recurso de talentos em um job.

```http
GET /job-talents/:jobId/talents/:talentId
```

--------------------------------

### Obter Vaga por ID (cURL)

Source: https://docs.inhire.com.br/api/obter-vaga

Exemplo de como fazer uma requisição GET para obter os detalhes de uma vaga específica usando cURL. Substitua ':id' pelo ID real da vaga.

```bash
curl -L 'https://api.inhire.app/jobs/:id' \
-H 'Accept: application/json'
```

--------------------------------

### GET /jobs/positions/paginated/:jobId

Source: https://docs.inhire.com.br/api/obter-posicoes-paginadas

Retrieves paginated job positions for a specific job. You can control the number of positions per page and specify a starting point for pagination.

```APIDOC
## GET /jobs/positions/paginated/:jobId

### Description
This endpoint returns paginated positions for a job. You can specify query parameters to control the number of positions returned and the starting point of the pagination using a position identifier.

### Method
GET

### Endpoint
/jobs/positions/paginated/:jobId

### Parameters
#### Query Parameters
- **limit** (number) - Optional - Maximum number of positions to display per page.
- **startKey** (string) - Optional - Identifier marking where the list of positions should begin. Use this parameter to continue from the last position displayed in the previous call.

### Response
#### Success Response (200)
- **items** (object[]) - An array of position objects.
  - **requisitionId** (string) - Optional - If the position originated from a Requisition, the ID of the Requisition will be populated.
  - **updatedAt** (string) - The timestamp when the position was last updated.
  - **createdAt** (string) - The timestamp when the position was created.
  - **jobId** (string) - Optional - The ID of the job associated with this position.
  - **id** (string) - The unique identifier for the position.
  - **reason** (string) - The reason for the position. Possible values: [`expansion`, `replacement`, `other`].
  - **hiredAt** (string) - Optional - The timestamp when the position was filled.
  - **approvedAt** (string) - Optional - The timestamp when the position was approved.
  - **startKey** (object) - Optional - An object containing the ID of the current position, used for subsequent pagination. If this object is null, it means there are no more records to return.
    - **id** (string) - Optional - The identifier for the current position.
- **jobId** (string) - Optional - The ID of the job.
- **tenantId** (string) - Optional - The ID of the tenant.

### Request Example
```json
{
  "example": "request body"
}
```

### Response Example
```json
{
  "items": [
    {
      "requisitionId": "req_123",
      "updatedAt": "2023-10-27T10:00:00Z",
      "createdAt": "2023-10-26T09:00:00Z",
      "jobId": "job_abc",
      "id": "pos_xyz",
      "reason": "expansion",
      "hiredAt": null,
      "approvedAt": "2023-10-26T10:00:00Z",
      "startKey": {
        "id": "pos_xyz"
      }
    }
  ],
  "jobId": "job_abc",
  "tenantId": "tenant_1"
}
```
```

--------------------------------

### POST /tenants/clients

Source: https://docs.inhire.com.br/api/criar-cliente

Creates a new client for the tenant. Requires an Authorization header and a JSON request body containing client details.

```APIDOC
## POST /tenants/clients

### Description
Creates a new client for the tenant.

### Method
POST

### Endpoint
/tenants/clients

### Parameters
#### Header Parameters
- **Authorization** (string) - REQUIRED - Bearer token de autorização para validar o acesso.

#### Request Body
- **name** (string) - REQUIRED
- **cnpj** (string) - Optional
- **site** (string) - Optional
- **linkedin** (string) - Optional
- **logo** (string) - Optional
- **contacts** (object[]) - Optional
  - **name** (string) - REQUIRED
  - **phone** (string) - Optional
  - **email** (string) - REQUIRED

### Request Example
```json
{
  "name": "Novo Cliente",
  "cnpj": "12.345.678/0001-90",
  "site": "https://www.cliente.com.br",
  "linkedin": "https://www.linkedin.com/company/cliente",
  "logo": "https://storage.googleapis.com/inhire-logos/client-logo.png",
  "contacts": [
    {
      "name": "Contato Principal",
      "phone": "+5511999999999",
      "email": "contato@cliente.com.br"
    }
  ]
}
```

### Response
#### Success Response (201)
- **id** (string) - OPTIONAL
- **contacts** (object[]) - OPTIONAL
- **linkedin** (string) - OPTIONAL
- **logo** (string) - OPTIONAL
- **cnpj** (string) - OPTIONAL - CNPJ do cliente no formato XX.XXX.XXX/XXXX-XX
- **site** (string) - OPTIONAL - Site oficial do cliente
- **name** (string) - OPTIONAL
- **tenantId** (string) - OPTIONAL
- **status** (string) - OPTIONAL
- **createdAt** (date-time) - OPTIONAL

#### Response Example
```json
{
  "id": "some-client-id",
  "contacts": [
    {
      "name": "Contato Principal",
      "phone": "+5511999999999",
      "email": "contato@cliente.com.br"
    }
  ],
  "linkedin": "https://www.linkedin.com/company/cliente",
  "logo": "https://storage.googleapis.com/inhire-logos/client-logo.png",
  "cnpj": "12.345.678/0001-90",
  "site": "https://www.cliente.com.br",
  "name": "Novo Cliente",
  "tenantId": "some-tenant-id",
  "status": "active",
  "createdAt": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Exemplo de Requisição cURL para Atualizar Cliente

Source: https://docs.inhire.com.br/api/atualizar-cliente

Este exemplo demonstra como fazer uma requisição cURL para atualizar um cliente. Substitua os placeholders conforme necessário.

```curl
curl -L 'https://api.inhire.app' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
```

--------------------------------

### Duplicate Job Request Body Example

Source: https://docs.inhire.com.br/api/duplicar-vaga

This is an example of the JSON request body for duplicating a job. It includes the source job ID, duplication options for various aspects like tags and forms, and new details for the duplicated job.

```json
{
  "duplicateFrom": {
    "id": "string",
    "name": "string"
  },
  "duplication": {
    "tags": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "subscriptionForms": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "testForms": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "diversity": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "workflows": {
      "checked": true,
      "options": {
        "active": true
      }
    },
    "scorecard": {
      "checked": true,
      "options": {
        "active": true
      }
    }
  },
  "name": "string",
  "positions": [
    {
      "reason": "expansion"
    }
  ],
  "requisitions": [
    {
      "id": "string",
      "positions": [
        {
          "reason": "expansion"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /requisitions/:requisitionId

Source: https://docs.inhire.com.br/api/obter-requisicao

Retrieves a specific requisition by its ID.

```APIDOC
## GET /requisitions/:requisitionId

### Description
Returns a requisition by its ID.

### Method
GET

### Endpoint
/requisitions/:requisitionId

### Parameters
#### Path Parameters
- **requisitionId** (string) - REQUIRED - The ID of the requisition to retrieve.

### Response
#### Success Response (200)
- **id** (string) - OPTIONAL - The unique identifier of the requisition.
- **name** (string) - OPTIONAL - The name of the requisition.
- **approvers** (object[]) - OPTIONAL - A list of approvers for the requisition.
  - **name** (string) - OPTIONAL - The name of the approver.
  - **email** (string) - OPTIONAL - The email of the approver.
- **status** (string) - OPTIONAL - The current status of the requisition. Possible values: `pending`, `approved`, `rejected`.
- **tenantId** (string) - OPTIONAL - The ID of the tenant associated with the requisition.
- **salaryMin** (number) - OPTIONAL - The minimum salary for the position.
- **salaryMax** (number) - OPTIONAL - The maximum salary for the position.
- **jobId** (string) - OPTIONAL - The ID of the job posting.
- **description** (string) - OPTIONAL - A description of the requisition.
- **contractType** (string[]) - OPTIONAL - The type of contract. Possible values: `CLT`, `Cooperado`, `Estágio`, `Menor aprendiz`, `PJ`.
- **positions** (object[]) - OPTIONAL - Details about the positions.
  - **reason** (string) - OPTIONAL - The reason for the requisition. Possible values: `expansion`, `replacement`, `other`.

### Request Example
```json
{
  "example": "request body"
}
```

### Response Example
```json
{
  "id": "string",
  "name": "string",
  "approvers": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "status": "pending",
  "tenantId": "string",
  "salaryMin": 0,
  "salaryMax": 0,
  "jobId": "string",
  "description": "string",
  "contractType": [
    "CLT"
  ],
  "positions": [
    {
      "reason": "expansion"
    }
  ]
}
```
```

--------------------------------

### Exemplo de requisição Go

Source: https://docs.inhire.com.br/api

Exemplo de como executar a requisição para ativar/desativar um usuário usando Go.

```go
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"log"
	"net/http"
)

func main() {
	userId := "some-user-id"
	enabled := true

	requestBody, err := json.Marshal(map[string]bool{"enabled": enabled})
	if err != nil {
		log.Fatalf("Error marshaling JSON: %v", err)
	}

	url := fmt.Sprintf("https://auth.inhire.app/users/%s/enable", userId)

	req, err := http.NewRequest("POST", url, bytes.NewBuffer(requestBody))
	if err != nil {
		log.Fatalf("Error creating request: %v", err)
	}
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	res, err := client.Do(req)
	if err != nil {
		log.Fatalf("Error sending request: %v", err)
	}
	defer res.Body.Close()

	if res.StatusCode == http.StatusNoContent {
		fmt.Println("User status updated successfully")
	} else {
		fmt.Printf("Failed to update user status. Status code: %d\n", res.StatusCode)
	}
}
```

--------------------------------

### Exemplo de requisição Node.js

Source: https://docs.inhire.com.br/api

Exemplo de como executar a requisição para ativar/desativar um usuário usando Node.js.

```javascript
const userId = 'some-user-id';
const enabled = true;

fetch(`https://auth.inhire.app/users/${userId}/enable`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ enabled })
})
.then(response => {
  if (response.ok) {
    console.log('User status updated successfully');
  } else {
    console.error('Failed to update user status');
  }
})
.catch(error => {
  console.error('Error:', error);
});
```

--------------------------------

### GET /forms/scorecards/interviews/job/:jobId

Source: https://docs.inhire.com.br/api/obter-todos-os-kits-de-entrevista-de-uma-vaga

Retrieves all interview kits for a given job.

```APIDOC
## GET /forms/scorecards/interviews/job/:jobId

### Description
Obtem todos os Kits de Entrevista de uma Vaga

### Method
GET

### Endpoint
/forms/scorecards/interviews/job/:jobId

### Parameters
#### Header Parameters
- **Authorization** (string) - REQUIRED - Authentication token.

### Responses
#### Success Response (200)
Kits de Entrevista obtidos com sucesso. Optional.
- **jobId** (string) - Optional.
- **skillCategories** (object[]) - Optional.
  - **name** (string) - Optional.
- **skills** (object[]) - Optional.
  - **name** (string) - Optional.
- **visible** (boolean) - Optional.
- **script** (string) - Optional.
- **jobStageId** (string) - Optional.
- **name** (string) - Optional.
- **userName** (string) - Optional.
- **userId** (string) - Optional.
- **tenantId** (string) - Optional.
- **id** (string) - Optional.
- **createdAt** (string) - Optional.
- **updatedAt** (string) - Optional.

### Request Example
```json
{
  "example": "request body"
}
```

### Response Example
```json
{
  "jobId": "string",
  "skillCategories": [
    {
      "name": "string",
      "skills": [
        {
          "name": "string"
        }
      ]
    }
  ],
  "visible": true,
  "script": "string",
  "jobStageId": "string",
  "name": "string",
  "userName": "string",
  "userId": "string",
  "tenantId": "string",
  "id": "string",
  "createdAt": "string",
  "updatedAt": "string"
}
```
```

--------------------------------

### GET /jobs/:id

Source: https://docs.inhire.com.br/api/obter-vaga

Retrieves a specific job posting by its ID.

```APIDOC
## GET /jobs/:id

### Description
Retrieves a specific job posting using its unique identifier.

### Method
GET

### Endpoint
/jobs/:id

### Parameters
#### Path Parameters
- **id** (string) - REQUIRED - The unique identifier of the job posting.

### Response
#### Success Response (200)
- **acceptedSeniority** (string[]) - OPTIONAL - Possible values: [`junior`, `mid-level`, `senior`, `specialist`, `leadership`]
- **area** (string) - OPTIONAL
- **contractType** (string[]) - OPTIONAL - Possible values: [`CLT`, `Cooperado`, `Estágio`, `Menor aprendiz`, `PJ`]
- **createdAt** (string) - OPTIONAL
- **id** (string) - OPTIONAL
- **languagePrimary** (string) - OPTIONAL
- **locationRequired** (boolean) - OPTIONAL
- **name** (string) - OPTIONAL
- **offLimits** (undefined[]) - OPTIONAL
- **salaryMax** (number) - OPTIONAL
- **salaryMin** (number) - OPTIONAL
- **seniority** (string) - OPTIONAL - Possible values: [`junior`, `mid-level`, `senior`, `specialist`, `leadership`]
- **specialization** (string) - OPTIONAL - Possible values: [`back-end`, `devops`, `front-end`, `full-stack`]
- **status** (string) - OPTIONAL - Possible values: [`canceled`, `closed`, `open`, `paused`, `pending`] Status da vaga
- **talentSuggestions** (boolean) - OPTIONAL
- **updatedAt** (string) - OPTIONAL

### Request Example
```curl
curl -L 'https://api.inhire.app/jobs/:id' \
-H 'Accept: application/json'
```
```

--------------------------------

### Exemplo de requisição Python

Source: https://docs.inhire.com.br/api

Exemplo de como executar a requisição para ativar/desativar um usuário usando Python.

```python
import requests
import json

user_id = "some-user-id"
enabled = True

url = f"https://auth.inhire.app/users/{user_id}/enable"
headers = {
    "Content-Type": "application/json"
}
data = {
    "enabled": enabled
}

response = requests.post(url, headers=headers, data=json.dumps(data))

if response.status_code == 204:
    print("User status updated successfully")
else:
    print(f"Failed to update user status. Status code: {response.status_code}")
```

--------------------------------

### GET /forms/scorecards/jobTalent/:jobTalentId

Source: https://docs.inhire.com.br/api/obter-os-resumo-das-entrevistas-de-um-candidato

Retrieves a summary of interviews for a specific candidate.

```APIDOC
## GET /forms/scorecards/jobTalent/:jobTalentId

### Description
Obter os resumo das entrevistas de um Candidato

### Method
GET

### Endpoint
/forms/scorecards/jobTalent/:jobTalentId

### Parameters
#### Path Parameters
- **jobTalentId** (string) - REQUIRED - ID of the job talent.

#### Header Parameters
- **Authorization** (string) - REQUIRED - Authentication token.

### Response
#### Success Response (200)
Resumo das entrevistas obtido com sucesso

- **evaluationsFeedbacks** (object[]) - OPTIONAL - Array of evaluation feedbacks.
  - **annotations** (string) - OPTIONAL - Annotations for the feedback.
  - **comment** (string) - OPTIONAL - Comment for the feedback.
  - **proceed** (string) - OPTIONAL - Proceed status. Possible values: [`DEFINITELY_NOT`, `DEFINITELY_YES`, `NOT`, `YES`].
  - **scorecardInterviewId** (string) - OPTIONAL - ID of the scorecard interview.
  - **scorecardInterviewName** (string) - OPTIONAL - Name of the scorecard interview.
  - **skillComments** (object[]) - OPTIONAL - Array of skill comments.
    - **comments** (object[]) - OPTIONAL - Array of comments for the skill.
      - **comment** (string) - OPTIONAL - Comment for the skill.
    - **scorecardInterviewId** (string) - OPTIONAL - ID of the scorecard interview.
    - **scorecardInterviewName** (string) - OPTIONAL - Name of the scorecard interview.
    - **name** (string) - OPTIONAL - Name of the skill.
    - **skillsScore** (object[]) - OPTIONAL - Array of skill scores.
      - **name** (string) - OPTIONAL - Name of the skill.
      - **score** (number) - OPTIONAL - Score for the skill.
      - **skills** (object[]) - OPTIONAL - Array of skills.
        - **cantEvaluate** (boolean) - OPTIONAL - Indicates if the skill cannot be evaluated.
        - **description** (string) - OPTIONAL - Description of the skill.
        - **score** (number) - OPTIONAL - Score for the skill.
        - **userId** (string) - OPTIONAL - User ID associated with the skill.
        - **userName** (string) - OPTIONAL - User name associated with the skill.

### Request Example
(No request body example provided in the source)

### Response Example
(No response body example provided in the source)
```

--------------------------------

### GET /websites/inhire_br_api/pages/{id}

Source: https://docs.inhire.com.br/api/obter-uma-pagina-de-divulgacao

Retrieves the details of a specific job disclosure page.

```APIDOC
## GET /websites/inhire_br_api/pages/{id}

### Description
Retrieves the details of a specific job disclosure page.

### Method
GET

### Endpoint
/websites/inhire_br_api/pages/{id}

### Parameters
#### Path Parameters
- **id** (string) - REQUIRED - The unique identifier of the disclosure page.

### Response
#### Success Response (200)
- **openGraph** (object) - OPTIONAL - Data for Open Graph.
  - **description** (string) - OPTIONAL
  - **image** (string) - OPTIONAL
  - **title** (string) - OPTIONAL
  - **tenantName** (string) - OPTIONAL
- **about** (string) - OPTIONAL - Information about the company. This field is common to all disclosure pages as it is a Tenant configuration.
- **background** (string[]) - OPTIONAL - URL of the background images for the page's Hero section.
- **logo** (string) - OPTIONAL - URL of the company logo image. This field is common to all disclosure pages as it is a Tenant configuration.
- **createdAt** (string) - OPTIONAL - The date the page was created.
- **lastPublishedAt** (string) - OPTIONAL - The date and time the page was last made public.
- **location** (string) - OPTIONAL - The location of the job.
- **publishedAt** (string) - OPTIONAL - The date and time the page was first made public.
- **updatedAt** (string) - OPTIONAL - The date and time the page was last updated.
- **workplaceType** (string) - OPTIONAL - Possible values: [`On-site`, `Hybrid`, `Remote`]. The type of workplace.
- **careerPageId** (string) - OPTIONAL - The ID of the career page, if this disclosure page belongs to a career page other than the Tenant's default.
- **activeJobBoards** (string[]) - OPTIONAL - Possible values: [`indeed`, `indeedATSIntegration`, `jobBoardPool`, `linkedin`, `netVagas`, `talent`, `trampos`, `careerjet`, `empregos-aqui`, `jobrapido`, `jobs-brasil`, `jobsora`, `jooble`, `joobta`, `joonow`, `empregos`, `engenha`, `estagiarios.com`, `havagas`, `jobzi`, `rio-vagas`, `vaga-net`, `vagassc`, `walljobs`]. List of active Job Boards for this disclosure page.
- **contractType** (string[]) - OPTIONAL - Possible values: [`CLT`, `Cooperado`, `Estágio`, `Menor aprendiz`, `PJ`].
- **description** (string) - OPTIONAL - The main text content of the disclosure page. May contain HTML.
- **displayName** (string) - OPTIONAL - The title of the disclosure page. This may differ from the job's actual name, as it's a talent-focused title, while the job name might have internal nomenclatures.
- **jobBoardsData** (object) - OPTIONAL - If this disclosure page is published on any jobBoard, this field may contain an integration ID with the jobBoard.
  - **[jobBoardName]** (object) - OPTIONAL - Specific data for the Job Board. Can be any object without a defined shape.
- **jobId** (string) - OPTIONAL - The ID of the job.
- **settings** (object) - OPTIONAL - Settings for the application form, such as required fields, email, etc.
  - **email** (object) - OPTIONAL - The email that the candidate will receive upon applying. This is applicable if this functionality is enabled for this disclosure page.
    - **active** (boolean) - OPTIONAL
    - **body** (string) - OPTIONAL
    - **bodyRaw** (string) - OPTIONAL - DEPRECATED
    - **includeSignature** (boolean) - OPTIONAL - Whether the email should include the recruiter's signature.
    - **senderType** (string) - OPTIONAL - Possible values: [`personal`, `system`]. Whether the email should be sent by the recruiter or by InHire.
    - **subject** (string) - OPTIONAL
    - **subjectRaw** (string) - OPTIONAL - DEPRECATED
    - **templateId** (string) - OPTIONAL - The email template ID.
  - **fields** (string[]) - OPTIONAL - Possible values: [`salary`, `linkedin`, `curriculum`, `location`, `referral`]. Fields that should be displayed in the application form.
  - **requiredFields** (string[]) - OPTIONAL - Possible values: [`salary`, `linkedin`, `curriculum`, `location`, `referral`]. Fields that should be mandatory in the application form.
- **status** (string) - OPTIONAL - Possible values: [`published`, `unlisted`, `unpublished`]. The status of the disclosure page.
  - `published`: The disclosure page is published.
  - `unpublished`: The disclosure page is not published.
  - `unlisted`: The disclosure page is not published but is accessible via a direct link.
- **privacyPolicyUrl** (string) - OPTIONAL - The URL of the company's privacy policy.
- **diversity** (object) - OPTIONAL - Diversity form questions, if active for this job.
  - **active** (boolean) - OPTIONAL - Whether the diversity form is active for this job.
  - **introduction** (string) - OPTIONAL - Introductory text for the diversity form.
  - **questions** (object[]) - OPTIONAL - Questions for the diversity form.
    - **active** (boolean) - OPTIONAL - Whether the question is active.
    - **answerOptions** (object[]) - OPTIONAL - Answer options for the question.
      - **id** (string) - OPTIONAL - The ID of the answer option.
      - **description** (string) - OPTIONAL - The description of the answer option.
      - **order** (number) - OPTIONAL - The order of the answer option.
```

--------------------------------

### POST /job-talents/talents/statuses/batch

Source: https://docs.inhire.com.br/api/atualizar-status-das-candidaturas

Atualiza o status de múltiplas candidaturas simultaneamente.

```APIDOC
## POST /job-talents/talents/statuses/batch

### Description
Este endpoint permite atualizar o status de múltiplas candidaturas simultaneamente, passando um array de candidaturas e o novo status desejado.

### Method
POST

### Endpoint
https://api.inhire.app/job-talents/talents/statuses/batch

### Parameters
#### Request Body
- **status** (string) - Required - Novo status das candidaturas. Valores possíveis: `active`, `declined`, `rejected`.
- **jobTalents** (object[]) - Required - Candidaturas a serem atualizadas.
  - **id** (string) - Required - ID da candidatura.

### Request Example
{
  "status": "active",
  "jobTalents": [
    {
      "id": "b9a4a1b5-7fcb-4f5a-8f5f-1c2a3b4c5d6e"
    }
  ]
}

### Response
#### Success Response (200)
- **jobTalentId** (string) - Optional
- **status** (string) - Optional
- **jobTalentStatus** (object) - Optional
  - **status** (string) - Optional
  - **previousStatus** (string) - Optional
  - **reason** (string) - Optional
  - **talentId** (string) - Optional
  - **id** (string) - Optional
```
Tokens:
Raw