Skip to main content
GET
/
interview
/
invites
Get all invited candidates
curl --request GET \
  --url https://public.api.micro1.ai/interview/invites \
  --header 'x-api-key: <api-key>'
{
  "status": "true",
  "message": "Candidate invites fetched successfully",
  "data": [
    {
      "candidate_id": "h0gqkAcaDJ",
      "interview_id": "123e4567-e89b-12d3-a456-426614174000",
      "interview_name": "Full Stack Engineer Interview",
      "candidate_name": "John Doe",
      "candidate_email_id": "[email protected]",
      "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

​
interview_id
string

ID of the interview

​
candidate_id
string

ID of the candidate

Response

Successful response

Response for getting all candidate invites

​
status
boolean

Status of the response

Example:

"true"

​
message
string

Message of the response

Example:

"Candidate invites fetched successfully"

​
data
Report · object[]

List of candidate invites