Skip to content
/
Retrieve a vacancy by id

Vacancy API (2.0)

This API will allow you to configure and read vacancies with all their internal features.

Download OpenAPI description
index.json
index.yaml
Overview
Enzo García
enzo.garcia@hunty.com
License
Propietary software
Languages
Servers
Mock server
https://docs.hunty.cloud/_mock/apis/vacancy_api
Development Server
https://k8s-exp-api-dev.hunty.cloud/v2/vacancies
Production Server
https://k8s-exp-api-stg.hunty.cloud/v2/vacancies

Vacancy

Endpoints for vacancy management and retrieval

Operations

Retrieve a vacancy by id

Request

Security
bearer or apiKey
Path
vacancyIdstringrequired
companyIdstringrequired
curl -i -X GET \
  'https://docs.hunty.cloud/_mock/apis/vacancy_api/{vacancyId}/company/{companyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
shortCodestring or nullrequired
Example: "VAC-2024-001"
typestringrequired
Value"Standard"
Example: "Standard"
companyIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
localestringrequired
Example: "es"
createdByUserIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
locationIdnumber or nullrequired
Example: 12345
countrystring or nullrequired
Example: "MX"
statusobject(Status)required
status.​codestringrequired
Enum"SAVED""CLOSED""IN_PROGRESS"
Example: "SAVED"
status.​createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
areaIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
visibilitystringrequired
Enum"PUBLIC""PRIVATE"
Example: "PUBLIC"
workModalitystringrequired
Enum"ON_SITE""REMOTE""HYBRID"
Example: "HYBRID"
namestringrequired
Example: "Desarrollador Full Stack Senior"
maxCandidatesnumber or nullrequired
Example: 50
jobDescriptionstringrequired
Example: "Buscamos un desarrollador Full Stack con experiencia en React y Node.js"
jobDescriptionHtmlstringrequired
Example: "<p>Buscamos un desarrollador Full Stack con experiencia en <strong>React</strong> y <strong>Node.js</strong></p>"
requirementsstring or nullrequired
Example: "Experiencia mínima de 3 años en desarrollo web"
requirementsHtmlstring or nullrequired
Example: "<p>Experiencia mínima de 3 años en desarrollo web</p>"
contextAIstring or nullrequired
Example: "Posición para equipo de desarrollo de producto"
featuresArray of objects(Feature)required
features[].​idstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
features[].​featureCodestringrequired
Enum"INTERVIEW""DOCUMENTS""AUTOMATIC_ENGLISH_EXAM""AUTOMATIC_SCHEDULING_VIRTUAL""AUTOMATIC_SCHEDULING_PRESENTIAL""AUTOMATIC_SCHEDULING_AUTO""AUTOMATIC_PSYCHOMETRIC""AUTOMATIC_FORM"
Example: "INTERVIEW"
features[].​ordernumberrequired
Example: 1
features[].​isAutomaticbooleanrequired
Example: true
features[].​colorstringrequired
Example: "#4A90E2"
features[].​customNamestringrequired
Example: "Entrevista inicial"
features[].​actionsArray of objects(FeatureAction)required
features[].​actions[].​idstringrequired
Example: "start"
features[].​actions[].​templateIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
features[].​selfInitbooleanrequired
Example: false
features[].​jobAutomationsEnglishExamFeatureJobAutomations (object) or FormFeatureJobAutomations (object) or PsychometricFeatureJobAutomations (object) or SchedulingAutoFeatureJobAutomations (object) or SchedulingPresentialFeatureJobAutomations (object) or SchedulingVirtualFeatureJobAutomations (object) or DocumentsFeatureJobAutomations (object)required
One of:
features[].​jobAutomations.​discardDueToInactivityInResultValidationTimenumberrequired
Example: 3
features[].​jobAutomations.​discardDueToInactivityInResultValidationTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features[].​jobAutomations.​discardDueToInactivityInErrorTimenumberrequired
Example: 2
features[].​jobAutomations.​discardDueToInactivityInErrorTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features[].​jobAutomations.​discardDueToLackOfInterestTimenumberrequired
Example: 7
features[].​jobAutomations.​discardDueToLackOfInterestTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
hasFinalistsEnabledbooleanrequired
taskListArray of objects(Task)required
taskList[].​idstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
taskList[].​ordernumberrequired
Example: 1
taskList[].​textstringrequired
Example: "Validar experiencia en el puesto"
taskList[].​sourcestringrequired
Enum"GPT""COMPANY""CUSTOM"
Example: "COMPANY"
taskList[].​typestringrequired
Enum"Qualifying""Informative""Disqualifier"
Example: "Qualifying"
taskList[].​relatedFieldstring or nullrequired
Example: "experience"
taskList[].​versionnumberrequired
Example: 1
taskList[].​versionDatestring(date-time)required
Example: "2024-01-15T10:30:00Z"
refCodestring or nullrequired
Example: "REF-2024-001"
jobAutomationsobject(JobAutomations)required
jobAutomations.​frozenDueToFinalistInactivityTimenumberrequired
Example: 7
jobAutomations.​frozenDueToFinalistInactivityTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
jobAutomations.​frozenDueToSelectionInactivityTimenumberrequired
Example: 14
jobAutomations.​frozenDueToSelectionInactivityTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
updatedAtstring(date-time)required
Example: "2024-01-20T15:45:00Z"
Response
application/json
{
  "id": "6705d9eb9f2f72a28f6c974f",
  "shortCode": "VAC-2024-001",
  "type": "Standard",
  "companyId": "6705d9eb9f2f72a28f6c974f",
  "locale": "es",
  "createdByUserId": "6705d9eb9f2f72a28f6c974f",
  "locationId": 12345,
  "country": "MX",
  "status": {
    "code": "SAVED",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "areaId": "6705d9eb9f2f72a28f6c974f",
  "visibility": "PUBLIC",
  "workModality": "HYBRID",
  "name": "Desarrollador Full Stack Senior",
  "maxCandidates": 50,
  "jobDescription": "Buscamos un desarrollador Full Stack con experiencia en React y Node.js",
  "jobDescriptionHtml": "<p>Buscamos un desarrollador Full Stack con experiencia en <strong>React</strong> y <strong>Node.js</strong></p>",
  "requirements": "Experiencia mínima de 3 años en desarrollo web",
  "requirementsHtml": "<p>Experiencia mínima de 3 años en desarrollo web</p>",
  "contextAI": "Posición para equipo de desarrollo de producto",
  "features": [
    { … }
  ],
  "hasFinalistsEnabled": true,
  "taskList": [
    { … }
  ],
  "refCode": "REF-2024-001",
  "jobAutomations": {
    "frozenDueToFinalistInactivityTime": 7,
    "frozenDueToFinalistInactivityTimeUnit": "days",
    "frozenDueToSelectionInactivityTime": 14,
    "frozenDueToSelectionInactivityTimeUnit": "days"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T15:45:00Z"
}

Create a new vacancy

Request

Security
bearer or apiKey
Path
companyIdstringrequired
Bodyapplication/jsonrequired
featuresSchedulingPresentialFeature (object) or SchedulingVirtualFeature (object) or SchedulingAutoFeature (object) or WithoutDataFeature (object) or PsychometricFeature (object) or FormFeature (object) or EnglishExamFeature (object) or DocumentsFeature (object)required
One of:
features.​idstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
features.​ordernumberrequired
Example: 0
features.​isAutomaticbooleanrequired
Example: true
features.​colorstringrequired
Example: "#000000"
features.​customNamestringrequired
Example: "Agendamiento Virtual"
features.​featureCodestringrequired
Value"AUTOMATIC_SCHEDULING_PRESENTIAL"
Example: "AUTOMATIC_SCHEDULING_PRESENTIAL"
features.​actionsArray of objects(FeatureAction)required
features.​actions[].​idstringrequired
Example: "start"
features.​actions[].​templateIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
features.​selfInitbooleanrequired
Example: false
features.​dataobject(SchedulingPresentialFeatureData)required
features.​data.​namestringrequired
Example: "Entrevista presencial"
features.​data.​timezonestringrequired
Example: "America/Mexico_City"
features.​data.​remindersArray of objects(SchedulingFeatureReminder)required
features.​data.​reminders[].​leadTimenumberrequired
Example: 24
features.​data.​reminders[].​timeUnitstringrequired
Example: "hours"
features.​data.​locationstringrequired
Example: "Oficinas centrales, Av. Reforma 123, CDMX"
features.​data.​additionalInformationstringrequired
Example: "Por favor traer identificación oficial"
features.​data.​possibleDatesArray of objects(SchedulingPresentialFeaturePossibleDate)required
features.​data.​possibleDates[].​datestring(date-time)required
Example: "2024-02-01T10:00:00Z"
features.​data.​possibleDates[].​durationnumberrequired
Example: 60
features.​jobAutomationsobject(SchedulingPresentialFeatureJobAutomations)required
features.​jobAutomations.​discardDueToInactivityInToScheduleTimenumberrequired
Example: 1440
features.​jobAutomations.​discardDueToInactivityInToScheduleTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features.​jobAutomations.​discardDueToInactivityInAttendanceValidationTimenumberrequired
Example: 1440
features.​jobAutomations.​discardDueToInactivityInAttendanceValidationTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features.​jobAutomations.​discardDueToInactivityInErrorTimenumberrequired
Example: 1440
features.​jobAutomations.​discardDueToInactivityInErrorTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features.​jobAutomations.​discardDueToInactivityAfterBeingCancelledTimenumberrequired
Example: 1440
features.​jobAutomations.​discardDueToInactivityAfterBeingCancelledTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features.​jobAutomations.​discardDueToLackOfInterestTimenumberrequired
Example: 1440
features.​jobAutomations.​discardDueToLackOfInterestTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
typestringrequired
Enum"Standard""Branch"
namestringrequired
visibilitystringrequired
Enum"PUBLIC""PRIVATE"
areaIdstringrequired
countrystring or nullrequired
locationIdnumber or nullrequired
workModalitystringrequired
Enum"ON_SITE""REMOTE""HYBRID"
jobDescriptionstringrequired
jobDescriptionHtmlstringrequired
requirementsstring or nullrequired
requirementsHtmlstring or nullrequired
contextAIstring or nullrequired
hasFinalistsEnabledbooleanrequired
maxCandidatesnumber or nullrequired
refCodenumber or nullrequired
jobAutomationsobjectrequired
jobAutomations.​frozenDueToFinalistInactivityTimenumberrequired
Example: 7
jobAutomations.​frozenDueToFinalistInactivityTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
jobAutomations.​frozenDueToSelectionInactivityTimenumberrequired
Example: 14
jobAutomations.​frozenDueToSelectionInactivityTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
curl -i -X POST \
  'https://docs.hunty.cloud/_mock/apis/vacancy_api/company/{companyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "features": {
      "id": "6705d9eb9f2f72a28f6c974f",
      "order": 0,
      "isAutomatic": true,
      "color": "#000000",
      "customName": "Agendamiento Virtual",
      "featureCode": "AUTOMATIC_SCHEDULING_PRESENTIAL",
      "actions": [
        {
          "id": "start",
          "templateId": "6705d9eb9f2f72a28f6c974f"
        }
      ],
      "selfInit": false,
      "data": {
        "name": "Entrevista presencial",
        "timezone": "America/Mexico_City",
        "reminders": [
          {
            "leadTime": 24,
            "timeUnit": "hours"
          }
        ],
        "location": "Oficinas centrales, Av. Reforma 123, CDMX",
        "additionalInformation": "Por favor traer identificación oficial",
        "possibleDates": [
          {
            "date": "2024-02-01T10:00:00Z",
            "duration": 60
          }
        ]
      },
      "jobAutomations": {
        "discardDueToInactivityInToScheduleTime": 1440,
        "discardDueToInactivityInToScheduleTimeUnit": "days",
        "discardDueToInactivityInAttendanceValidationTime": 1440,
        "discardDueToInactivityInAttendanceValidationTimeUnit": "days",
        "discardDueToInactivityInErrorTime": 1440,
        "discardDueToInactivityInErrorTimeUnit": "days",
        "discardDueToInactivityAfterBeingCancelledTime": 1440,
        "discardDueToInactivityAfterBeingCancelledTimeUnit": "days",
        "discardDueToLackOfInterestTime": 1440,
        "discardDueToLackOfInterestTimeUnit": "days"
      }
    },
    "type": "Standard",
    "name": "string",
    "visibility": "PUBLIC",
    "areaId": "string",
    "country": "string",
    "locationId": 0,
    "workModality": "ON_SITE",
    "jobDescription": "string",
    "jobDescriptionHtml": "string",
    "requirements": "string",
    "requirementsHtml": "string",
    "contextAI": "string",
    "hasFinalistsEnabled": true,
    "maxCandidates": 0,
    "refCode": 0,
    "jobAutomations": {
      "frozenDueToFinalistInactivityTime": 7,
      "frozenDueToFinalistInactivityTimeUnit": "days",
      "frozenDueToSelectionInactivityTime": 14,
      "frozenDueToSelectionInactivityTimeUnit": "days"
    }
  }'

Responses

Created

Bodyapplication/json
idstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
shortCodestring or nullrequired
Example: "VAC-2024-001"
typestringrequired
Value"Standard"
Example: "Standard"
companyIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
localestringrequired
Example: "es"
createdByUserIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
locationIdnumber or nullrequired
Example: 12345
countrystring or nullrequired
Example: "MX"
statusobject(Status)required
status.​codestringrequired
Enum"SAVED""CLOSED""IN_PROGRESS"
Example: "SAVED"
status.​createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
areaIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
visibilitystringrequired
Enum"PUBLIC""PRIVATE"
Example: "PUBLIC"
workModalitystringrequired
Enum"ON_SITE""REMOTE""HYBRID"
Example: "HYBRID"
namestringrequired
Example: "Desarrollador Full Stack Senior"
maxCandidatesnumber or nullrequired
Example: 50
jobDescriptionstringrequired
Example: "Buscamos un desarrollador Full Stack con experiencia en React y Node.js"
jobDescriptionHtmlstringrequired
Example: "<p>Buscamos un desarrollador Full Stack con experiencia en <strong>React</strong> y <strong>Node.js</strong></p>"
requirementsstring or nullrequired
Example: "Experiencia mínima de 3 años en desarrollo web"
requirementsHtmlstring or nullrequired
Example: "<p>Experiencia mínima de 3 años en desarrollo web</p>"
contextAIstring or nullrequired
Example: "Posición para equipo de desarrollo de producto"
featuresArray of objects(Feature)required
features[].​idstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
features[].​featureCodestringrequired
Enum"INTERVIEW""DOCUMENTS""AUTOMATIC_ENGLISH_EXAM""AUTOMATIC_SCHEDULING_VIRTUAL""AUTOMATIC_SCHEDULING_PRESENTIAL""AUTOMATIC_SCHEDULING_AUTO""AUTOMATIC_PSYCHOMETRIC""AUTOMATIC_FORM"
Example: "INTERVIEW"
features[].​ordernumberrequired
Example: 1
features[].​isAutomaticbooleanrequired
Example: true
features[].​colorstringrequired
Example: "#4A90E2"
features[].​customNamestringrequired
Example: "Entrevista inicial"
features[].​actionsArray of objects(FeatureAction)required
features[].​actions[].​idstringrequired
Example: "start"
features[].​actions[].​templateIdstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
features[].​selfInitbooleanrequired
Example: false
features[].​jobAutomationsEnglishExamFeatureJobAutomations (object) or FormFeatureJobAutomations (object) or PsychometricFeatureJobAutomations (object) or SchedulingAutoFeatureJobAutomations (object) or SchedulingPresentialFeatureJobAutomations (object) or SchedulingVirtualFeatureJobAutomations (object) or DocumentsFeatureJobAutomations (object)required
One of:
features[].​jobAutomations.​discardDueToInactivityInResultValidationTimenumberrequired
Example: 3
features[].​jobAutomations.​discardDueToInactivityInResultValidationTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features[].​jobAutomations.​discardDueToInactivityInErrorTimenumberrequired
Example: 2
features[].​jobAutomations.​discardDueToInactivityInErrorTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
features[].​jobAutomations.​discardDueToLackOfInterestTimenumberrequired
Example: 7
features[].​jobAutomations.​discardDueToLackOfInterestTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
hasFinalistsEnabledbooleanrequired
taskListArray of objects(Task)required
taskList[].​idstringrequired
Example: "6705d9eb9f2f72a28f6c974f"
taskList[].​ordernumberrequired
Example: 1
taskList[].​textstringrequired
Example: "Validar experiencia en el puesto"
taskList[].​sourcestringrequired
Enum"GPT""COMPANY""CUSTOM"
Example: "COMPANY"
taskList[].​typestringrequired
Enum"Qualifying""Informative""Disqualifier"
Example: "Qualifying"
taskList[].​relatedFieldstring or nullrequired
Example: "experience"
taskList[].​versionnumberrequired
Example: 1
taskList[].​versionDatestring(date-time)required
Example: "2024-01-15T10:30:00Z"
refCodestring or nullrequired
Example: "REF-2024-001"
jobAutomationsobject(JobAutomations)required
jobAutomations.​frozenDueToFinalistInactivityTimenumberrequired
Example: 7
jobAutomations.​frozenDueToFinalistInactivityTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
jobAutomations.​frozenDueToSelectionInactivityTimenumberrequired
Example: 14
jobAutomations.​frozenDueToSelectionInactivityTimeUnitstringrequired
Enum"days""minutes""hours"
Example: "days"
createdAtstring(date-time)required
Example: "2024-01-15T10:30:00Z"
updatedAtstring(date-time)required
Example: "2024-01-20T15:45:00Z"
Response
application/json
{
  "id": "6705d9eb9f2f72a28f6c974f",
  "shortCode": "VAC-2024-001",
  "type": "Standard",
  "companyId": "6705d9eb9f2f72a28f6c974f",
  "locale": "es",
  "createdByUserId": "6705d9eb9f2f72a28f6c974f",
  "locationId": 12345,
  "country": "MX",
  "status": {
    "code": "SAVED",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "areaId": "6705d9eb9f2f72a28f6c974f",
  "visibility": "PUBLIC",
  "workModality": "HYBRID",
  "name": "Desarrollador Full Stack Senior",
  "maxCandidates": 50,
  "jobDescription": "Buscamos un desarrollador Full Stack con experiencia en React y Node.js",
  "jobDescriptionHtml": "<p>Buscamos un desarrollador Full Stack con experiencia en <strong>React</strong> y <strong>Node.js</strong></p>",
  "requirements": "Experiencia mínima de 3 años en desarrollo web",
  "requirementsHtml": "<p>Experiencia mínima de 3 años en desarrollo web</p>",
  "contextAI": "Posición para equipo de desarrollo de producto",
  "features": [
    { … }
  ],
  "hasFinalistsEnabled": true,
  "taskList": [
    { … }
  ],
  "refCode": "REF-2024-001",
  "jobAutomations": {
    "frozenDueToFinalistInactivityTime": 7,
    "frozenDueToFinalistInactivityTimeUnit": "days",
    "frozenDueToSelectionInactivityTime": 14,
    "frozenDueToSelectionInactivityTimeUnit": "days"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-20T15:45:00Z"
}