Get all saved interviews

GET

interviews

curl --request GET \
  --url https://public.api.micro1.ai/interviews \
  --header 'x-api-key: <api-key>'

{
  "status": "true",
  "message": "Interviews fetched successfully",
  "data": [
    {
      "interview_id": "123e4567-e89b-12d3-a456-426614174000",
      "interview_name": "Full Stack Engineer Interview",
      "invite_url": "https://interview.micro1.ai/intro/micro1?uid=123e4567-e89b-12d3-a456-426614174000",
      "skills": [
        {
          "name": "React",
          "description": "Must be proficient in React Context API"
        }
      ],
      "custom_questions": [
        "Where do you see yourself in 5 years?"
      ],
      "interview_language": "English",
      "can_change_interview_language": false,
      "only_coding_round": true,
      "is_coding_round_required": true,
      "selected_coding_language": "Python",
      "is_proctoring_required": true,
      "date_created": "2021-01-01 00:00:00",
      "date_modified": "2021-01-01 00:00:00",
      "status": "active"
    }
  ]
}

Authorizations

x-api-key

string

header

required

API key to access the API

Query Parameters

page

integer

Page number

limit

integer

Number of items per page

keyword

string

Keyword to search for

Response

200

application/json

Successful response

Response for getting all interviews

status

boolean

Status of the response

Example:

"true"

message

string

Message of the response

Example:

"Interviews fetched successfully"

data

object[]

List of interviews

Interview object

data.interview_id

string

ID of the interview

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.interview_name

string

Name of the interview

Example:

"Full Stack Engineer Interview"

data.invite_url

string

The URL to invite the candidates to the interview

Example:

"https://interview.micro1.ai/intro/micro1?uid=123e4567-e89b-12d3-a456-426614174000"

data.skills

object[]

Required skills for the interview

Example:

[
  {
    "name": "React",
    "description": "Must be proficient in React Context API"
  }
]

data.custom_questions

string[]

Custom questions for the interview

Custom question for the interview

Example:

["Where do you see yourself in 5 years?"]

data.interview_language

string

Language of the interview

Example:

"English"

data.can_change_interview_language

boolean

Whether the candidate can change the interview language

Example:

false

data.only_coding_round

boolean

Whether the interview is a coding round only

Example:

true

data.is_coding_round_required

boolean

Whether the coding round is required

Example:

true

data.selected_coding_language

string

The coding language for the coding round

Example:

"Python"

data.is_proctoring_required

boolean

Whether the proctoring is required

Example:

true

data.date_created

string

Date created of the interview

Example:

"2021-01-01 00:00:00"

data.date_modified

string

Date modified of the interview

Example:

"2021-01-01 00:00:00"

data.status

string

Status of the interview

Example:

"active"

Create a new interview Update an interview

curl --request GET \
  --url https://public.api.micro1.ai/interviews \
  --header 'x-api-key: <api-key>'

{
  "status": "true",
  "message": "Interviews fetched successfully",
  "data": [
    {
      "interview_id": "123e4567-e89b-12d3-a456-426614174000",
      "interview_name": "Full Stack Engineer Interview",
      "invite_url": "https://interview.micro1.ai/intro/micro1?uid=123e4567-e89b-12d3-a456-426614174000",
      "skills": [
        {
          "name": "React",
          "description": "Must be proficient in React Context API"
        }
      ],
      "custom_questions": [
        "Where do you see yourself in 5 years?"
      ],
      "interview_language": "English",
      "can_change_interview_language": false,
      "only_coding_round": true,
      "is_coding_round_required": true,
      "selected_coding_language": "Python",
      "is_proctoring_required": true,
      "date_created": "2021-01-01 00:00:00",
      "date_modified": "2021-01-01 00:00:00",
      "status": "active"
    }
  ]
}

Getting Started

Interview

Invite Candidate

Interview Reports

Webhook

Get all saved interviews

Authorizations

Query Parameters

Response