Position

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

GET/org/{org_id}/position

curl https://nervai.hrmless.com/api/v1/org/:org_id/position \
  --header 'Authorization: <api-key>'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "state": "active",
    "department": "department",
    "location": "location",
    "min_score": 0,
    "role_description": "role_description",
    "position_calender_link": "position_calender_link",
    "created_at": "2024-08-25T15:00:00Z",
    "accepted_languages": [],
    "updated_at": "2024-08-25T15:00:00Z",
    "agent_id": "agent_id",
    "questionaire": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "name",
        "value": "value",
        "is_knockout": true,
        "expected_result": "expected_result"
      }
    ],
    "created_by": {
      "id": "id",
      "first_name": "first_name",
      "last_name": "last_name",
      "email": "[email protected]",
      "phone": "phone",
      "role": "role",
      "enabled": true
    },
    "candidate_stage": "candidate_stage",
    "passed_stage": "passed_stage",
    "rejected_stage": "rejected_stage",
    "needs_reviewed_stage": "needs_reviewed_stage",
    "auto_update_stages": true,
    "kombo_job_id_id": "kombo_job_id_id",
    "kombo_integration_id": "kombo_integration_id"
  }
]

json

application/json

Create position

POST

https://nervai.hrmless.com/api/v1

/org/{org_id}/position

Create a position

Create position › path Parameters

org_id

string · required

Create position › Request Body

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

Create position › Responses

200

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

POST/org/{org_id}/position

curl https://nervai.hrmless.com/api/v1/org/:org_id/position \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "state": "active",
  "department": "department",
  "location": "location",
  "min_score": 0,
  "role_description": "role_description",
  "position_calender_link": "position_calender_link",
  "created_at": "2024-08-25T15:00:00Z",
  "accepted_languages": [],
  "updated_at": "2024-08-25T15:00:00Z",
  "agent_id": "agent_id",
  "questionaire": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "value": "value",
      "is_knockout": true,
      "expected_result": "expected_result"
    }
  ],
  "created_by": {
    "id": "id",
    "first_name": "first_name",
    "last_name": "last_name",
    "email": "[email protected]",
    "phone": "phone",
    "role": "role",
    "enabled": true
  },
  "candidate_stage": "candidate_stage",
  "passed_stage": "passed_stage",
  "rejected_stage": "rejected_stage",
  "needs_reviewed_stage": "needs_reviewed_stage",
  "auto_update_stages": true,
  "kombo_job_id_id": "kombo_job_id_id",
  "kombo_integration_id": "kombo_integration_id"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "state": "active",
  "department": "department",
  "location": "location",
  "min_score": 0,
  "role_description": "role_description",
  "position_calender_link": "position_calender_link",
  "created_at": "2024-08-25T15:00:00Z",
  "accepted_languages": [],
  "updated_at": "2024-08-25T15:00:00Z",
  "agent_id": "agent_id",
  "questionaire": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "value": "value",
      "is_knockout": true,
      "expected_result": "expected_result"
    }
  ],
  "created_by": {
    "id": "id",
    "first_name": "first_name",
    "last_name": "last_name",
    "email": "[email protected]",
    "phone": "phone",
    "role": "role",
    "enabled": true
  },
  "candidate_stage": "candidate_stage",
  "passed_stage": "passed_stage",
  "rejected_stage": "rejected_stage",
  "needs_reviewed_stage": "needs_reviewed_stage",
  "auto_update_stages": true,
  "kombo_job_id_id": "kombo_job_id_id",
  "kombo_integration_id": "kombo_integration_id"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "state": "active",
  "department": "department",
  "location": "location",
  "min_score": 0,
  "role_description": "role_description",
  "position_calender_link": "position_calender_link",
  "created_at": "2024-08-25T15:00:00Z",
  "accepted_languages": [],
  "updated_at": "2024-08-25T15:00:00Z",
  "agent_id": "agent_id",
  "questionaire": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "value": "value",
      "is_knockout": true,
      "expected_result": "expected_result"
    }
  ],
  "created_by": {
    "id": "id",
    "first_name": "first_name",
    "last_name": "last_name",
    "email": "[email protected]",
    "phone": "phone",
    "role": "role",
    "enabled": true
  },
  "candidate_stage": "candidate_stage",
  "passed_stage": "passed_stage",
  "rejected_stage": "rejected_stage",
  "needs_reviewed_stage": "needs_reviewed_stage",
  "auto_update_stages": true,
  "kombo_job_id_id": "kombo_job_id_id",
  "kombo_integration_id": "kombo_integration_id"
}

json

application/json

Get position by ID

GET

https://nervai.hrmless.com/api/v1

/org/{org_id}/position/{position_id}

Get position by ID

Get position by ID › path Parameters

org_id

string · required

position_id

string · required

Get position by ID › Responses

200

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

GET/org/{org_id}/position/{position_id}

curl https://nervai.hrmless.com/api/v1/org/:org_id/position/:position_id \
  --header 'Authorization: <api-key>'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "state": "active",
  "department": "department",
  "location": "location",
  "min_score": 0,
  "role_description": "role_description",
  "position_calender_link": "position_calender_link",
  "created_at": "2024-08-25T15:00:00Z",
  "accepted_languages": [],
  "updated_at": "2024-08-25T15:00:00Z",
  "agent_id": "agent_id",
  "questionaire": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "value": "value",
      "is_knockout": true,
      "expected_result": "expected_result"
    }
  ],
  "created_by": {
    "id": "id",
    "first_name": "first_name",
    "last_name": "last_name",
    "email": "[email protected]",
    "phone": "phone",
    "role": "role",
    "enabled": true
  },
  "candidate_stage": "candidate_stage",
  "passed_stage": "passed_stage",
  "rejected_stage": "rejected_stage",
  "needs_reviewed_stage": "needs_reviewed_stage",
  "auto_update_stages": true,
  "kombo_job_id_id": "kombo_job_id_id",
  "kombo_integration_id": "kombo_integration_id"
}

json

application/json

Update position by ID

PUT

https://nervai.hrmless.com/api/v1

/org/{org_id}/position/{position_id}

Update/Partial Update Position Object By ID

Update position by ID › path Parameters

org_id

string · required

position_id

string · required

Update position by ID › Request Body

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

Update position by ID › Responses

200

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

PUT/org/{org_id}/position/{position_id}

curl https://nervai.hrmless.com/api/v1/org/:org_id/position/:position_id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "state": "active",
  "department": "department",
  "location": "location",
  "min_score": 0,
  "role_description": "role_description",
  "position_calender_link": "position_calender_link",
  "created_at": "2024-08-25T15:00:00Z",
  "accepted_languages": [],
  "updated_at": "2024-08-25T15:00:00Z",
  "agent_id": "agent_id",
  "questionaire": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "value": "value",
      "is_knockout": true,
      "expected_result": "expected_result"
    }
  ],
  "created_by": {
    "id": "id",
    "first_name": "first_name",
    "last_name": "last_name",
    "email": "[email protected]",
    "phone": "phone",
    "role": "role",
    "enabled": true
  },
  "candidate_stage": "candidate_stage",
  "passed_stage": "passed_stage",
  "rejected_stage": "rejected_stage",
  "needs_reviewed_stage": "needs_reviewed_stage",
  "auto_update_stages": true,
  "kombo_job_id_id": "kombo_job_id_id",
  "kombo_integration_id": "kombo_integration_id"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "state": "active",
  "department": "department",
  "location": "location",
  "min_score": 0,
  "role_description": "role_description",
  "position_calender_link": "position_calender_link",
  "created_at": "2024-08-25T15:00:00Z",
  "accepted_languages": [],
  "updated_at": "2024-08-25T15:00:00Z",
  "agent_id": "agent_id",
  "questionaire": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "value": "value",
      "is_knockout": true,
      "expected_result": "expected_result"
    }
  ],
  "created_by": {
    "id": "id",
    "first_name": "first_name",
    "last_name": "last_name",
    "email": "[email protected]",
    "phone": "phone",
    "role": "role",
    "enabled": true
  },
  "candidate_stage": "candidate_stage",
  "passed_stage": "passed_stage",
  "rejected_stage": "rejected_stage",
  "needs_reviewed_stage": "needs_reviewed_stage",
  "auto_update_stages": true,
  "kombo_job_id_id": "kombo_job_id_id",
  "kombo_integration_id": "kombo_integration_id"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "state": "active",
  "department": "department",
  "location": "location",
  "min_score": 0,
  "role_description": "role_description",
  "position_calender_link": "position_calender_link",
  "created_at": "2024-08-25T15:00:00Z",
  "accepted_languages": [],
  "updated_at": "2024-08-25T15:00:00Z",
  "agent_id": "agent_id",
  "questionaire": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "value": "value",
      "is_knockout": true,
      "expected_result": "expected_result"
    }
  ],
  "created_by": {
    "id": "id",
    "first_name": "first_name",
    "last_name": "last_name",
    "email": "[email protected]",
    "phone": "phone",
    "role": "role",
    "enabled": true
  },
  "candidate_stage": "candidate_stage",
  "passed_stage": "passed_stage",
  "rejected_stage": "rejected_stage",
  "needs_reviewed_stage": "needs_reviewed_stage",
  "auto_update_stages": true,
  "kombo_job_id_id": "kombo_job_id_id",
  "kombo_integration_id": "kombo_integration_id"
}

json

application/json

Delete position by ID

DELETE

https://nervai.hrmless.com/api/v1

/org/{org_id}/position/{position_id}

Delete position by ID

Delete position by ID › path Parameters

org_id

string · required

position_id

string · required

Delete position by ID › Responses

No data returned

Organization Candidates

Get all positions

GET

https://nervai.hrmless.com/api/v1

/org/{org_id}/position

Get all positions

Get all positions › path Parameters

org_id

string · required

Get all positions › Responses

200

Position[]

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

Create position

POST

https://nervai.hrmless.com/api/v1

/org/{org_id}/position

Create a position

Create position › path Parameters

org_id

string · required

Create position › Request Body

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

Create position › Responses

200

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

Get position by ID

GET

https://nervai.hrmless.com/api/v1

/org/{org_id}/position/{position_id}

Get position by ID

Get position by ID › path Parameters

org_id

string · required

position_id

string · required

Get position by ID › Responses

200

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

Update position by ID

PUT

https://nervai.hrmless.com/api/v1

/org/{org_id}/position/{position_id}

Update/Partial Update Position Object By ID

Update position by ID › path Parameters

org_id

string · required

position_id

string · required

Update position by ID › Request Body

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

Update position by ID › Responses

200

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255