# HackerRank

> Manage tests, candidate invitations and interviews, and read users, teams and assessment reports.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/hackerrank

## Actions

### Archive test

Archive test.

**Inputs**

- Id (`id`, text, required): ID of the test

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Create interview

Create interview.

**Inputs**

- From (`start_at`, date and time): Date and time.
- To (`end_at`, date and time): Date and time.
- Title (`title`, text, required): Title of interview
- Notes (`notes`, text): Notes for interviewer
- Resume url (`resume_url`, text): Candidate's resume link
- Interviewers (`interviewers`, list): List of interviewers to invite for the interview. You can either send an array of interviewer' ' emails or an array of the type: [{email: 'example@company.com', name: 'Interviewer'}]. On update, this value is only read to replace the existing interviewers when replace_interviewers is set to true.
- Result url (`result_url`, text): Webhook url for results to be posted after interview is ended, or when thumbs/feedback is changed on a completed interview
- Candidate (`candidate`, object): Candidate to invite for the interview.
- Send email (`send_email`, true/false): Send/Resend invitation email to Interview Attendants. Default: `false`.
- Replace interviewers (`replace_interviewers`, true/false): If set to true, the interviewers list is replaced with the interviewers provided.
- Metadata (`metadata`, object): Any additional information related to the interview.
- Interview template ID (`interview_template_id`, number): ID of the interview template
- Ai assistant available (`ai_assistant_available`, true/false): If set to true, AI assistant will be available for this interview. Applicable only when AI add-on and AI assistant setting are enabled for the company.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "ai_assistant_available": false,
    "candidate": {},
    "created_at": "example",
    "ended_at": "example",
    "feedback": "example",
    "from": "example",
    "id": "example",
    "interview_template_id": 1,
    "interviewers": [],
    "metadata": {},
    "notes": "example",
    "report_url": "example",
    "result_url": "example",
    "resume_url": "example",
    "started_at": "example",
    "status": "new",
    "thumbs_up": 1,
    "title": "example",
    "to": "example",
    "updated_at": "example",
    "url": "example",
    "user": 1
  }
}
```

### Create test

Create test.

**Inputs**

- Name (`name`, text, required): Name of the test.
- Starttime (`starttime`, date and time): Date and time.
- Endtime (`endtime`, date and time): Date and time.
- Duration (`duration`, number, required): Duration of test in minutes.
- Instructions (`instructions`, text): HTML for instructions displayed to candidate in the test login page.
- Locked (`locked`, true/false): Whether this test is locked or not. Locked test cannot be edited, however candidates can be invited to the test.
- Draft (`draft`, true/false): Describes if this test is currently in Draft(true)/Published(false) state. Candidates can only be invited for published tests. One of: `true`, `false`. Default: `true`.
- Languages (`languages`, list): List of languages available in the test for coding and approximate questions. Note: *null* in this fields means that all languages are enabled
- Candidate details (`candidate_details`, list): List of details that candidates will be asked to enter before logging into the test. These details will be available in the report view of the test. It should be an Array of JSON.List of default fields:[full_name, city, work_experience, roll_number, email_address, year_of_graduation, cgpa, univ, phone_number, contact_recruiter, branch, gender, degree, role, resume, pgdegree, city_graduation, gpa, major, linkedin]For default fields add field in following way {predefined_label: 'roll_number', requ
- Custom acknowledge text (`custom_acknowledge_text`, text): Candidate will be asked to agree to this text before logging into the test.
- Cutoff score (`cutoff_score`, number): If set, then candidates scoring equal or more than this value will automatically be placed into "Qualified" bucket, while candidates scoring less will be placed in "Failed" bucket
- Master password (`master_password`, text): If set, candidates can login to the test using this password
- Hide compile test (`hide_compile_test`, true/false): If set to true then candidate will not be able to see compile button for coding and approximate type questions.
- Tags (`tags`, list): List of tags associated with this test
- Role IDs (`role_ids`, list, required): List of role ids associated with this test.
- Experience (`experience`, list, required): Experience levels associated with this test. One or more of: `Intern`, `New Graduate`, `0-2 years`, `2-5 years`, `>5 years`, `All Experience Levels`.
- Questions (`questions`, list): List of question ids associated with this test.
- Mcq incorrect score (`mcq_incorrect_score`, number): Score to deduct from total score per incorect MCQ question
- Mcq correct score (`mcq_correct_score`, number): Score to add to total score per correct MCQ question
- Shuffle questions (`shuffle_questions`, true/false): If true than questions will be shuffled
- Test admins (`test_admins`, list): Test admins will also receive summary report mails when candidate completes a test.
- Hide template (`hide_template`, true/false): If set to true then head and tail templates will not be shown to candidates.
- Enable acknowledgement (`enable_acknowledgement`, true/false): If set to false, then candidate will not be asked to agree to acknowledgement text.
- Enable proctoring (`enable_proctoring`, true/false): If set to true, then this will force the candidate to turn their webcam on before starting the Test.We will take snapshots periodically during the Test, and you can view them in the Candidate's report.This corresponds to Image Proctoring setting under Integrity settings of a testBy default this field is set to false.
- Enable advanced proctoring (`enable_advanced_proctoring`, true/false): If set to true, candidate webcam photos are analyzed using AI to detect suspicious activity.We will take snapshots periodically during the Test, and you can view them in the Candidate's report.This corresponds to Image analysis setting under Integrity settings of a testBy default this field is set to false.
- Enable secure assessment mode (`enable_secure_assessment_mode`, true/false): If set to true, then this will enable secure mode for the test.This corresponds to Secure mode setting under Integrity settings of a testBy default this field is set to false.
- Enable ml plagiarism analysis (`enable_ml_plagiarism_analysis`, true/false): If set to true, this detects whether a candidate has received help from an external source.This corresponds to AI Plagiarism setting under Integrity settings of a testBy default this field is set to false.
- Enable photo IDentification (`enable_photo_identification`, true/false): If set to true, this requires candidates to take a photo before starting the test.This corresponds to Photo Identification setting under Integrity settings of a testBy default this field is set to false.
- Ide config (`ide_config`, text): Configure IDE for candidates to solve Front-end, Back-end, and Full-stack questions.Default is set to ide. One of: `ide_and_git` (Ide and git), `ide`, `git`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "candidate_details": [],
    "created_at": "example",
    "custom_acknowledge_text": "example",
    "cutoff_score": 1,
    "draft": true,
    "duration": 1,
    "enable_acknowledgement": false,
    "enable_advanced_proctoring": false,
    "enable_ml_plagiarism_analysis": false,
    "enable_photo_identification": false,
    "enable_proctoring": false,
    "enable_secure_assessment_mode": false,
    "endtime": "example",
    "experience": [],
    "hide_compile_test": false,
    "hide_template": false,
    "id": "example",
    "ide_config": "ide_and_git",
    "instructions": "example",
    "languages": [],
    "locked": false,
    "locked_by": "example",
    "master_password": "example",
    "mcq_correct_score": 1,
    "mcq_incorrect_score": 1,
    "name": "example",
    "owner": "example",
    "public_login_url": "example",
    "questions": [],
    "role_ids": [],
    "sections": {},
    "short_login_url": "example",
    "shuffle_questions": false,
    "starred": false,
    "starttime": "example",
    "state": "active",
    "tags": [],
    "test_admins": [],
    "unique_id": "example"
  }
}
```

### Get candidate

Get candidate.

**Inputs**

- Test (`test_id`, text, required): ID of the test
- Candidate ID (`candidate_id`, text, required): ID of the candidate
- Additional fields (`additional_fields`, text): Supported test candidate fields to get detailed info on those fields (Comma separated field names). For eg: 'questions,scores_sections_split'. This is used to get detailed information on the supported test candidate fields. Some supported fields are : 'questions' to get score details on each question, 'scores_sections_split' to get info on each test section, 'user' to get user details, 'test' to get test details, etc

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "accept_result_updates": false,
    "added_time": "example",
    "ats_state": 1,
    "attempt_endtime": "example",
    "attempt_events": [],
    "attempt_metrics": [],
    "attempt_starttime": "example",
    "authenticated_report_url": "example",
    "candidate_details": [],
    "comments": {},
    "editor_paste_count": 1,
    "email": "example",
    "evaluator_email": "example",
    "feedback": "example",
    "full_name": "example",
    "id": "example",
    "integrity_status": "example",
    "integrity_summary": "example",
    "invite_email_done": false,
    "invite_link": "example",
    "invite_metadata": {},
    "invite_valid": false,
    "invite_valid_from": "example",
    "invite_valid_to": "example",
    "invited_on": "example",
    "ip_address": "example",
    "max_code_similarity": {},
    "out_of_window_duration": 1.0,
    "out_of_window_events": 1,
    "pdf_url": "example",
    "percentage_score": 1.0,
    "performance_summary": "example",
    "plagiarism": {},
    "plagiarism_status": false,
    "proctor_images": [],
    "questions": {
      "answer": "example",
      "answered": false,
      "metrics": [],
      "name": "example",
      "preview": "example",
      "score": 1
    },
    "report_url": "example",
    "score": 1.0,
    "scores_skills_split": {},
    "scores_tags_split": {},
    "secure_mode_exit_count": 1,
    "secure_mode_exit_duration": 1.0,
    "status": 1,
    "tags": [],
    "test": "example",
    "test_finish_url": "example",
    "test_result_url": "example",
    "unclaimed_added_time": 1,
    "user": "example"
  }
}
```

### Get interview

Get interview.

**Inputs**

- Interview ID (`interview_id`, text, required): ID of interview

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "ai_assistant_available": false,
    "candidate": {},
    "created_at": "example",
    "ended_at": "example",
    "feedback": "example",
    "from": "example",
    "id": "example",
    "interview_template_id": 1,
    "interviewers": [],
    "metadata": {},
    "notes": "example",
    "report_url": "example",
    "result_url": "example",
    "resume_url": "example",
    "started_at": "example",
    "status": "new",
    "thumbs_up": 1,
    "title": "example",
    "to": "example",
    "updated_at": "example",
    "url": "example",
    "user": 1
  }
}
```

### Get interview artifacts

Get interview artifacts.

**Inputs**

- Interview ID (`interview_id`, number, required): Numeric interview record ID.

**Outputs**

- `data` (object): Artifact metadata returned directly, without a data wrapper. A successful response can include unavailable artifacts and empty questions or interviewer_notes arrays.

**Example output**

```json
{
  "data": {
    "interview_id": "example",
    "interviewer_notes": [],
    "questions": [],
    "transcript_url": {
      "location": "example",
      "state": "available"
    }
  }
}
```

### Get interview notes

Get interview notes.

**Inputs**

- Interview ID (`interview_id`, text, required): ID of interview
- Note IDs (`note_ids`, list): Return only the notes with these IDs

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "notes": []
  }
}
```

### Get interview transcript

Get interview transcript.

**Inputs**

- Interview ID (`interview_id`, text, required): ID of interview

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "messages": []
  }
}
```

### Get invite template

Get invite template.

**Inputs**

- Template ID (`template_id`, text, required): ID of template

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "content": "example",
    "created_at": "example",
    "default": false,
    "id": "example",
    "name": "example",
    "subject": "example",
    "updated_at": "example",
    "user": "example"
  }
}
```

### Get team

Get team.

**Inputs**

- Id (`id`, text, required): ID of the team to retrieve

**Outputs**

- `data` (object): Team response

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "departments": [],
    "developer_cap": 1,
    "developer_count": 1,
    "id": "example",
    "invite_as": "example",
    "locations": [],
    "name": "example",
    "owner": "example",
    "recruiter_cap": 1,
    "recruiter_count": 1
  }
}
```

### Get test

Get test.

**Inputs**

- Id (`id`, text, required): ID of the Test
- Additional fields (`additional_fields`, text): Supported test fields to get detailed info on those fields (Comma separated field names). Following fields are supported: languages, candidate_details, custom_acknowledge_text, cutoff_score, cutoff_score_percentage, candidate_max_score, master_password, hide_compile_test, mcq_incorrect_score, mcq_correct_score, locked_by, secure, short_login_url, public_login_url, shuffle_questions, test_admins, hide_template, enable_acknowledgement, experience, job_roles, invited, in_progress, to_evaluate, qual

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "candidate_details": [],
    "created_at": "example",
    "custom_acknowledge_text": "example",
    "cutoff_score": 1,
    "draft": true,
    "duration": 1,
    "enable_acknowledgement": false,
    "enable_advanced_proctoring": false,
    "enable_ml_plagiarism_analysis": false,
    "enable_photo_identification": false,
    "enable_proctoring": false,
    "enable_secure_assessment_mode": false,
    "endtime": "example",
    "experience": [],
    "hide_compile_test": false,
    "hide_template": false,
    "id": "example",
    "ide_config": "ide_and_git",
    "instructions": "example",
    "languages": [],
    "locked": false,
    "locked_by": "example",
    "master_password": "example",
    "mcq_correct_score": 1,
    "mcq_incorrect_score": 1,
    "name": "example",
    "owner": "example",
    "public_login_url": "example",
    "questions": [],
    "role_ids": [],
    "sections": {},
    "short_login_url": "example",
    "shuffle_questions": false,
    "starred": false,
    "starttime": "example",
    "state": "active",
    "tags": [],
    "test_admins": [],
    "unique_id": "example"
  }
}
```

### Get user

Get user.

**Inputs**

- Id (`id`, text, required): The resource ID.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "activated": false,
    "candidates_permission": 0,
    "company_admin": false,
    "country": "example",
    "email": "example",
    "firstname": "example",
    "id": "example",
    "interviews_permission": 0,
    "last_activity_time": "example",
    "lastname": "example",
    "phone": "example",
    "questions_permission": 0,
    "role": "recruiter",
    "shared_candidates_permission": 0,
    "shared_interviews_permission": 0,
    "shared_questions_permission": 0,
    "shared_tests_permission": 0,
    "status": "locked",
    "team_admin": false,
    "teams": [],
    "tests_permission": 0,
    "timezone": "example"
  }
}
```

### Invite candidate

Invite candidate.

**Inputs**

- Test (`test_id`, text, required): ID of the test
- Full name (`full_name`, text): Full name of the candidate.
- Email (`email`, text, required): Email address of the candidate.
- Ats state (`ats_state`, number): This indicates the current state of the candidate application. Value can be from 0 to 22.
- Invite valid from (`invite_valid_from`, date and time): Invitation validity time.
- Invite valid to (`invite_valid_to`, date and time): Invitation validity time.
- Invite metadata (`invite_metadata`, object): Customizable metadata that can be set for a candidate. This must be a valid JSON object.
- Subject (`subject`, text): Subject of the candidate invite mail.
- Message (`message`, text): Custom message that will be prepended to the candidate invite mail body.
- Template (`template`, text): ID of the template to be used for inviting candidate.
- Evaluator email (`evaluator_email`, text): Email address of the evaluator, if different from the test admins and owner.
- Test finish url (`test_finish_url`, text): Candidate will be redirected to this URL when the test gets over. By default, they are sent to the feedback page.
- Test result url (`test_result_url`, text): Webhook URL for candidate report. When the report is processed the report data will be sent to this URL as a webhook. By default, the inviter will get the report by email.
- Webhook authentication (`webhook_authentication`, object): Authentication configuration for the webhook URL. Required when test_result_url is provided.
- Accept result updates (`accept_result_updates`, true/false): Flag to send score and status updates to the test_result_url. Please set to "true" if you accept updates. Default is "false".
- Send email (`send_email`, true/false): Flag to send the invite email to the candidate. Defaults to "false"; the invite is recorded but no email is sent. Pass "true" to send the invitation email. Default: `false`.
- Tags (`tags`, list): List of tags associated with this candidate.
- Force (`force`, true/false): Flag which forces sending an email even when the candidate has already been invited.
- Force reattempt (`force_reattempt`, true/false): Force re-invite even when the candidate has already attempted the test.
- Accommodations (`accommodations`, object): Object containing candidate accommodations.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "email": "example",
    "id": 1,
    "test_link": "example"
  }
}
```

### List candidates

List candidates.

**Inputs**

- Test (`test_id`, text, required): ID of the test
- Limit (`limit`, number): Returned value. From 1 to 100. Default: `100`.
- Offset (`offset`, number): Returned value. At least 0. Default: `0`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "first": "example",
    "last": "example",
    "next": "example",
    "offset": 1,
    "page_total": 1,
    "previous": "example",
    "total": "example"
  }
}
```

### List interviews

List interviews.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100. Default: `100`.
- Offset (`offset`, number): Returned value. At least 0. Default: `0`.
- Created at (`created_at`, text): It is the datetime when the interview was created. It needs to be passed in the form of "from..to". For example: 2024-01-21T13:36:21+0000..2024-01-22T00:00:00+0000. Both "from" and "to" are in form of YYYY-MM-DDThh:mm:ss±zzz where zzz is offset form UTC timezone in form of hh:mm including a leading zero for single digit hour value. All time values are 24 hour format
- Updated at (`updated_at`, text): It is the datetime when the interview was updated. It needs to be passed in the form of "from..to". For example: 2024-01-21T13:36:21+0000..2024-01-22T00:00:00+0000. Both "from" and "to" are in form of YYYY-MM-DDThh:mm:ss±zzz where zzz is offset form UTC timezone in form of hh:mm including a leading zero for single digit hour value. All time values are 24 hour format
- Ended at (`ended_at`, text): It is the datetime when the interview ended. It needs to be passed in the form of "from..to". For example: 2024-01-21T13:36:21+0000..2024-01-22T00:00:00+0000. Both "from" and "to" are in form of YYYY-MM-DDThh:mm:ss±zzz where zzz is offset form UTC timezone in form of hh:mm including a leading zero for single digit hour value. All time values are 24 hour format
- User (`user`, text): Filter by ID of the user who created the interview
- Interviewers (`interviewers`, text): Filter by ID of any one interviewer
- Access (`access`, text): Filter interviews based on access rights. It can have the following values: - owned - shared
- Current status (`current_status`, text): Filters all interviews based on the current status of the interview. 0: New 1: Active 2: Ended 3: Paused
- Order by (`order_by`, text): Sort the interviews in a specific order. It can have the following values: - title - id (ID of the interview) - created_at - ended_at - current_status - user
- Order dir (`order_dir`, text): Defines the direction of sorting. This parameter is required to be passed if you are using "order_by". It can have the following values: - asc: Ascending order - desc: Descending order

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "first": "example",
    "last": "example",
    "next": "example",
    "offset": 1,
    "page_total": 1,
    "previous": "example",
    "total": "example"
  }
}
```

### List invite templates

List invite templates.

**Inputs**

- Access (`access`, text): Access type (shared/owned)
- Limit (`limit`, number): limit. Default: `100`.
- Offset (`offset`, number): offset. Default: `0`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "first": "example",
    "last": "example",
    "next": "example",
    "offset": 1,
    "page_total": 1,
    "previous": "example",
    "total": "example"
  }
}
```

### List teams

List teams.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100. Default: `100`.
- Offset (`offset`, number): Returned value. At least 0. Default: `0`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "first": "example",
    "last": "example",
    "next": "example",
    "offset": 1,
    "page_total": 1,
    "previous": "example",
    "total": "example"
  }
}
```

### List test inviters

List test inviters.

**Inputs**

- Id (`id`, text, required): ID of the test
- Limit (`limit`, number): Returned value. From 1 to 100. Default: `100`.
- Offset (`offset`, number): Returned value. At least 0. Default: `0`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "first": "example",
    "last": "example",
    "next": "example",
    "offset": 1,
    "page_total": 1,
    "previous": "example",
    "total": "example"
  }
}
```

### List tests

List tests.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100. Default: `100`.
- Offset (`offset`, number): Returned value. At least 0. Default: `0`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "first": "example",
    "last": "example",
    "next": "example",
    "offset": 1,
    "page_total": 1,
    "previous": "example",
    "total": "example"
  }
}
```

### List users

List users.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100. Default: `100`.
- Offset (`offset`, number): Returned value. At least 0. Default: `0`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "first": "example",
    "last": "example",
    "next": "example",
    "offset": 1,
    "page_total": 1,
    "previous": "example",
    "total": "example"
  }
}
```
