Get Interview

List All Interviews

get

Retrieve a list of interviews with optional filters.

Authorizations

Query parameters

statusstring · enumOptionalExample: publishedPossible values:

pageintegerOptionalExample: 1

limitintegerOptionalExample: 10

searchstringOptional

Search by interview name or any other detail in the metadata

Responses

200

A list of interviews

application/json

Responseall of

401

Missing or invalid Authorization header

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/interview/get-interviews HTTP/1.1
Host: interview-api.zeko.ai
Authorization: Bearer JWT
Accept: */*

{
  "message": "Interview Fetched successfully",
  "success": true,
  "data": [
    {
      "interviewId": "67fe305cbebfbd2c5de3130a",
      "interviewName": "API Testing 2",
      "roleName": "Software Engineer",
      "minExperience": 3,
      "maxExperience": 5,
      "jdType": "link",
      "sampleQuestions": [
        "What is API testing?"
      ],
      "interviewConfig": {
        "redirectUrl": "https://example.com/callback",
        "allowAccess": "anyone",
        "allowLateAttempts": true,
        "allowContinueFromMiddle": true,
        "allowContinueFromMiddleCount": 1,
        "allowReattempt": false,
        "allowReattemptCount": 0,
        "allowInterviewOnMobile": false,
        "allowScreenLeaveCount": 2,
        "allowTabSwitchCount": 2,
        "webhookUrl": "https://example.com/webhook"
      },
      "interviewLink": "https://interview.zeko.ai/ai-interview/software-engineer8575574",
      "competencyData": [
        {
          "competency": "B2B Demand Generation",
          "explanation": "As an interviewer, you...",
          "difficulty": "medium",
          "questionType": "scenario_based",
          "questionCount": 4,
          "time": 90,
          "category": "vocal",
          "sampleQuestions": [
            "sample question 1"
          ]
        }
      ],
      "metaData": {
        "Id": 12345,
        "name": "012 - Tester Interview",
        "clientId": 12434311
      },
      "status": "published",
      "createdAt": "2025-08-26T17:36:55.868Z",
      "updatedAt": "2025-08-26T17:36:55.868Z"
    }
  ]
}

Get Interview by ID

get

Fetch detailed information for a single interview.

Authorizations

Path parameters

idstringRequired

The interview ID

Responses

200

Interview details

application/json

Responseall of

401

Missing or invalid Authorization header

application/json

404

Interview not found

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/interview/get-interview/{id} HTTP/1.1
Host: interview-api.zeko.ai
Authorization: Bearer JWT
Accept: */*

{
  "message": "Interview Fetched successfully",
  "success": true,
  "data": {
    "interviewId": "67f55dddb27e0a17d1228bf1",
    "interviewName": "John Doe Updated",
    "roleName": "Software Engineer",
    "minExperience": 3,
    "maxExperience": 13,
    "jdType": "text",
    "sampleQuestions": [
      "Ques1",
      "Ques2"
    ],
    "competencyData": [
      {
        "competency": "B2B Demand Generation",
        "explanation": "As an interviewer, you...",
        "difficulty": "medium",
        "questionType": "scenario_based",
        "questionCount": 4,
        "time": 90,
        "category": "vocal",
        "sampleQuestions": [
          "sample question 1"
        ]
      }
    ],
    "interviewConfig": {
      "redirectUrl": "https://example.com/callback",
      "allowAccess": "anyone",
      "allowLateAttempts": true,
      "allowContinueFromMiddle": true,
      "allowContinueFromMiddleCount": 1,
      "allowReattempt": false,
      "allowReattemptCount": 0,
      "allowInterviewOnMobile": false,
      "allowScreenLeaveCount": 2,
      "allowTabSwitchCount": 2,
      "webhookUrl": "https://example.com/webhook"
    },
    "metaData": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "status": "draft",
    "interviewLink": "https://interview.zeko.ai/ai-interview/software-engineer9165921",
    "createdAt": "2025-08-26T17:36:55.868Z",
    "updatedAt": "2025-08-26T17:36:55.868Z"
  }
}