Candidates

Get candidates

GET

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

/org/{org_id}/positions/{position_id}/

Get all candidates for a position

Get candidates › path Parameters

org_id

string · required

position_id

string · required

Get candidates › Responses

200

Candidate[]

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

GET/org/{org_id}/positions/{position_id}/

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

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "position_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "email": "[email protected]",
    "phone": "phone",
    "language": "language",
    "state": "state",
    "score": 0,
    "feedback": "feedback",
    "hired": true,
    "invited_at": "2024-08-25T15:00:00Z",
    "communications": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initial_email_sent": true,
      "initial_text_sent": true,
      "_3hr_reminder_text_sent": true,
      "day2_email_sent": true,
      "day2_text_sent": true,
      "day3_email_sent": true,
      "day3_text_sent": true,
      "day4_email_sent": true,
      "day4_text_sent": true,
      "day5_email_sent": true,
      "day5_text_sent": true,
      "passed_notification_sent": true,
      "rejected_notification_sent": true
    },
    "completed_at": "2024-08-25T15:00:00Z",
    "kombo_application_id": "kombo_application_id",
    "short_listed": false,
    "tags": [
      "string"
    ],
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Update candidates

PUT

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

/org/{org_id}/positions/{position_id}/

Update Candidates

Update candidates › path Parameters

org_id

string · required

position_id

string · required

Update candidates › Request Body

Candidate[]

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

Update candidates › Responses

200

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

PUT/org/{org_id}/positions/{position_id}/

curl https://nervai.hrmless.com/api/v1/org/:org_id/positions/:position_id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "position_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "email": "[email protected]",
    "phone": "phone",
    "language": "language",
    "state": "state",
    "score": 0,
    "feedback": "feedback",
    "hired": true,
    "invited_at": "2024-08-25T15:00:00Z",
    "communications": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initial_email_sent": true,
      "initial_text_sent": true,
      "_3hr_reminder_text_sent": true,
      "day2_email_sent": true,
      "day2_text_sent": true,
      "day3_email_sent": true,
      "day3_text_sent": true,
      "day4_email_sent": true,
      "day4_text_sent": true,
      "day5_email_sent": true,
      "day5_text_sent": true,
      "passed_notification_sent": true,
      "rejected_notification_sent": true
    },
    "completed_at": "2024-08-25T15:00:00Z",
    "kombo_application_id": "kombo_application_id",
    "short_listed": false,
    "tags": [
      "string"
    ],
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]'

Example Request Body

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "position_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "email": "[email protected]",
    "phone": "phone",
    "language": "language",
    "state": "state",
    "score": 0,
    "feedback": "feedback",
    "hired": true,
    "invited_at": "2024-08-25T15:00:00Z",
    "communications": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initial_email_sent": true,
      "initial_text_sent": true,
      "_3hr_reminder_text_sent": true,
      "day2_email_sent": true,
      "day2_text_sent": true,
      "day3_email_sent": true,
      "day3_text_sent": true,
      "day4_email_sent": true,
      "day4_text_sent": true,
      "day5_email_sent": true,
      "day5_text_sent": true,
      "passed_notification_sent": true,
      "rejected_notification_sent": true
    },
    "completed_at": "2024-08-25T15:00:00Z",
    "kombo_application_id": "kombo_application_id",
    "short_listed": false,
    "tags": [
      "string"
    ],
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "position_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "language": "language",
  "state": "state",
  "score": 0,
  "feedback": "feedback",
  "hired": true,
  "invited_at": "2024-08-25T15:00:00Z",
  "communications": {
    "id": "00000000-0000-0000-0000-000000000000",
    "initial_email_sent": true,
    "initial_text_sent": true,
    "_3hr_reminder_text_sent": true,
    "day2_email_sent": true,
    "day2_text_sent": true,
    "day3_email_sent": true,
    "day3_text_sent": true,
    "day4_email_sent": true,
    "day4_text_sent": true,
    "day5_email_sent": true,
    "day5_text_sent": true,
    "passed_notification_sent": true,
    "rejected_notification_sent": true
  },
  "completed_at": "2024-08-25T15:00:00Z",
  "kombo_application_id": "kombo_application_id",
  "short_listed": false,
  "tags": [
    "string"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Add candidates

POST

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

/org/{org_id}/positions/{position_id}/

Add candidates to a position

Add candidates › path Parameters

org_id

string · required

position_id

string · required

Add candidates › Request Body

PostionSerializerList[]

PostionSerializerList

name

string · minLength: 1 · maxLength: 200 · required

email

string · email · minLength: 1 · maxLength: 200 · required

phone

string · minLength: 1 · maxLength: 200 · required

language

string · minLength: 1 · maxLength: 200 · required

tags

string[] · unique

Communication

hired

boolean

kombo_application_id

string | null · minLength: 1 · maxLength: 100

short_listed

boolean | null

Add candidates › Responses

200

Candidate[]

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

POST/org/{org_id}/positions/{position_id}/

curl https://nervai.hrmless.com/api/v1/org/:org_id/positions/:position_id \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '[
  {
    "tags": [
      "string"
    ],
    "communications": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initial_email_sent": true,
      "initial_text_sent": true,
      "_3hr_reminder_text_sent": true,
      "day2_email_sent": true,
      "day2_text_sent": true,
      "day3_email_sent": true,
      "day3_text_sent": true,
      "day4_email_sent": true,
      "day4_text_sent": true,
      "day5_email_sent": true,
      "day5_text_sent": true,
      "passed_notification_sent": true,
      "rejected_notification_sent": true
    },
    "name": "name",
    "email": "[email protected]",
    "phone": "phone",
    "hired": true,
    "language": "language",
    "kombo_application_id": "kombo_application_id",
    "short_listed": true
  }
]'

Example Request Body

[
  {
    "tags": [
      "string"
    ],
    "communications": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initial_email_sent": true,
      "initial_text_sent": true,
      "_3hr_reminder_text_sent": true,
      "day2_email_sent": true,
      "day2_text_sent": true,
      "day3_email_sent": true,
      "day3_text_sent": true,
      "day4_email_sent": true,
      "day4_text_sent": true,
      "day5_email_sent": true,
      "day5_text_sent": true,
      "passed_notification_sent": true,
      "rejected_notification_sent": true
    },
    "name": "name",
    "email": "[email protected]",
    "phone": "phone",
    "hired": true,
    "language": "language",
    "kombo_application_id": "kombo_application_id",
    "short_listed": true
  }
]

json

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "position_id": "00000000-0000-0000-0000-000000000000",
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "email": "[email protected]",
    "phone": "phone",
    "language": "language",
    "state": "state",
    "score": 0,
    "feedback": "feedback",
    "hired": true,
    "invited_at": "2024-08-25T15:00:00Z",
    "communications": {
      "id": "00000000-0000-0000-0000-000000000000",
      "initial_email_sent": true,
      "initial_text_sent": true,
      "_3hr_reminder_text_sent": true,
      "day2_email_sent": true,
      "day2_text_sent": true,
      "day3_email_sent": true,
      "day3_text_sent": true,
      "day4_email_sent": true,
      "day4_text_sent": true,
      "day5_email_sent": true,
      "day5_text_sent": true,
      "passed_notification_sent": true,
      "rejected_notification_sent": true
    },
    "completed_at": "2024-08-25T15:00:00Z",
    "kombo_application_id": "kombo_application_id",
    "short_listed": false,
    "tags": [
      "string"
    ],
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Delete all candidates

DELETE

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

/org/{org_id}/positions/{position_id}/

Delete all Candidates from a position

Delete all candidates › path Parameters

org_id

string · required

position_id

string · required

Delete all candidates › Responses

No data returned

Get candidate by ID

GET

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

/org/{org_id}/positions/{position_id}/candidates/{candidate_id}/

Get a candidate by ID

Get candidate by ID › path Parameters

org_id

string · required

position_id

string · required

candidate_id

string · required

Get candidate by ID › Responses

200

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

GET/org/{org_id}/positions/{position_id}/candidates/{candidate_id}/

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

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "position_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "language": "language",
  "state": "state",
  "score": 0,
  "feedback": "feedback",
  "hired": true,
  "invited_at": "2024-08-25T15:00:00Z",
  "communications": {
    "id": "00000000-0000-0000-0000-000000000000",
    "initial_email_sent": true,
    "initial_text_sent": true,
    "_3hr_reminder_text_sent": true,
    "day2_email_sent": true,
    "day2_text_sent": true,
    "day3_email_sent": true,
    "day3_text_sent": true,
    "day4_email_sent": true,
    "day4_text_sent": true,
    "day5_email_sent": true,
    "day5_text_sent": true,
    "passed_notification_sent": true,
    "rejected_notification_sent": true
  },
  "completed_at": "2024-08-25T15:00:00Z",
  "kombo_application_id": "kombo_application_id",
  "short_listed": false,
  "tags": [
    "string"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update candidate by ID

PUT

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

/org/{org_id}/positions/{position_id}/candidates/{candidate_id}/

Update candidate

Update candidate by ID › path Parameters

org_id

string · required

position_id

string · required

candidate_id

string · required

Update candidate by ID › Request Body

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

Update candidate by ID › Responses

200

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

PUT/org/{org_id}/positions/{position_id}/candidates/{candidate_id}/

curl https://nervai.hrmless.com/api/v1/org/:org_id/positions/:position_id/candidates/:candidate_id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "position_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "language": "language",
  "state": "state",
  "score": 0,
  "feedback": "feedback",
  "hired": true,
  "invited_at": "2024-08-25T15:00:00Z",
  "communications": {
    "id": "00000000-0000-0000-0000-000000000000",
    "initial_email_sent": true,
    "initial_text_sent": true,
    "_3hr_reminder_text_sent": true,
    "day2_email_sent": true,
    "day2_text_sent": true,
    "day3_email_sent": true,
    "day3_text_sent": true,
    "day4_email_sent": true,
    "day4_text_sent": true,
    "day5_email_sent": true,
    "day5_text_sent": true,
    "passed_notification_sent": true,
    "rejected_notification_sent": true
  },
  "completed_at": "2024-08-25T15:00:00Z",
  "kombo_application_id": "kombo_application_id",
  "short_listed": false,
  "tags": [
    "string"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "position_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "language": "language",
  "state": "state",
  "score": 0,
  "feedback": "feedback",
  "hired": true,
  "invited_at": "2024-08-25T15:00:00Z",
  "communications": {
    "id": "00000000-0000-0000-0000-000000000000",
    "initial_email_sent": true,
    "initial_text_sent": true,
    "_3hr_reminder_text_sent": true,
    "day2_email_sent": true,
    "day2_text_sent": true,
    "day3_email_sent": true,
    "day3_text_sent": true,
    "day4_email_sent": true,
    "day4_text_sent": true,
    "day5_email_sent": true,
    "day5_text_sent": true,
    "passed_notification_sent": true,
    "rejected_notification_sent": true
  },
  "completed_at": "2024-08-25T15:00:00Z",
  "kombo_application_id": "kombo_application_id",
  "short_listed": false,
  "tags": [
    "string"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "position_id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "language": "language",
  "state": "state",
  "score": 0,
  "feedback": "feedback",
  "hired": true,
  "invited_at": "2024-08-25T15:00:00Z",
  "communications": {
    "id": "00000000-0000-0000-0000-000000000000",
    "initial_email_sent": true,
    "initial_text_sent": true,
    "_3hr_reminder_text_sent": true,
    "day2_email_sent": true,
    "day2_text_sent": true,
    "day3_email_sent": true,
    "day3_text_sent": true,
    "day4_email_sent": true,
    "day4_text_sent": true,
    "day5_email_sent": true,
    "day5_text_sent": true,
    "passed_notification_sent": true,
    "rejected_notification_sent": true
  },
  "completed_at": "2024-08-25T15:00:00Z",
  "kombo_application_id": "kombo_application_id",
  "short_listed": false,
  "tags": [
    "string"
  ],
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete candidate by ID

DELETE

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

/org/{org_id}/positions/{position_id}/candidates/{candidate_id}/

Delete candidate

Delete candidate by ID › path Parameters

org_id

string · required

position_id

string · required

candidate_id

string · required

Delete candidate by ID › Responses

No data returned

Get candidate interview

GET

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

/org/{org_id}/positions/{position_id}/candidates/{candidate_id}/interview/

Get interview details for a candidate

Get candidate interview › path Parameters

org_id

string · required

position_id

string · required

candidate_id

string · required

Get candidate interview › Responses

200

Interview

id

string · uuid

conversation_id

string | null · minLength: 1 · maxLength: 100

transcript_link

string | null · minLength: 1 · maxLength: 350

recording_link

string | null · minLength: 1 · maxLength: 350

start_time

string | null · date-time

end_time

string | null · date-time

graded_at

string | null · date-time

last_attempted_at

string | null · date-time

ip_address

string | null · minLength: 1

location

string | null · minLength: 1 · maxLength: 200

interview_link

string | null · minLength: 1 · maxLength: 200

status

string · enum

Enum values:

not_started

errored

cancelled

completed

graded

score

integer | null · min: -2147483648 · max: 2147483647

feedback

string | null · minLength: 1

interview_transcript

string | null · minLength: 1 · maxLength: 20000

candidate

string · uuid

GET/org/{org_id}/positions/{position_id}/candidates/{candidate_id}/interview/

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

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "conversation_id": "conversation_id",
  "transcript_link": "transcript_link",
  "recording_link": "recording_link",
  "start_time": "2024-08-25T15:00:00Z",
  "end_time": "2024-08-25T15:00:00Z",
  "graded_at": "2024-08-25T15:00:00Z",
  "last_attempted_at": "2024-08-25T15:00:00Z",
  "ip_address": "ip_address",
  "location": "location",
  "interview_link": "interview_link",
  "status": "not_started",
  "score": 0,
  "feedback": "feedback",
  "interview_transcript": "interview_transcript",
  "candidate": "00000000-0000-0000-0000-000000000000"
}

json

application/json

Position

Products

Industries

Resources

Company

Candidates

Get candidates

Get candidates › path Parameters

Get candidates › Responses

Update candidates

Update candidates › path Parameters

Update candidates › Request Body

Update candidates › Responses

Add candidates

Add candidates › path Parameters

Add candidates › Request Body

Add candidates › Responses

Delete all candidates

Delete all candidates › path Parameters

Delete all candidates › Responses

Get candidate by ID

Get candidate by ID › path Parameters

Get candidate by ID › Responses

Update candidate by ID

Update candidate by ID › path Parameters

Update candidate by ID › Request Body

Update candidate by ID › Responses

Delete candidate by ID

Delete candidate by ID › path Parameters

Delete candidate by ID › Responses

Get candidate interview

Get candidate interview › path Parameters

Get candidate interview › Responses