About iMochaHelpBook a demo
About iMochaHelpBook a demo
  1. Test
  • Introduction
  • Skills Assessment API
    • API Reference
      • Getting started
      • API Environment
      • Authentication Mechanism
      • Error Code
      • List timezones
    • Test
      • List all tests
        GET
      • Retrieve a test
        GET
      • Retrieve test settings
        GET
      • Update Test Settings
        POST
    • Test Invitations
      • Callback notification
      • Invite candidate
      • Invite candidate by test link
      • Reattempt Test
      • Cancel Invitation
    • Test Link
      • List all test links
    • Report
      • Retrieve candidate test report
      • Retrieve candidate test report in PDF
    • Callback API
      • Process Callbacks
      • Retrieve Invites
    • GDPR
      • GDPR Data Masking Service
    • Users
      • Get all business units
      • Create New User
      • Update User
      • Active/ Inactive User
  • Skills Intelligence API
    • Introduction
    • Authentication
    • Employee
      • List employees
      • Get Employee Skills by employeeId
      • Employee Enrollment
      • Update Employee Status
    • JobProfiles
      • Get All JobProfiles
      • Get JobProfile with Skills By JobProfileId
      • Create JobCode
    • Taxonomy
      • Get all Taxonomy Skills
    • CareerPath
      • Get Employee Career Path by employeeId
    • Account
      • Get Multichannel Validation Weightages
  1. Test

Retrieve test settings

GET
/v3/tests/{testId}/settings
⚙️ Retrieve current/default test settings for a given test.
Please refer to the testing settings in the app to map sub-objects in the API response.

Request

Path Params

Header Params

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://apiv3.imocha.io/v3/tests/{testId}/settings' \
--header 'x-api-key;'
Response Response Example
{
    "result": {
        "testSettings": {
            "testId": 0,
            "testName": "string",
            "testAliasName": "string",
            "typeOfTest": 0,
            "practiceTest": 0,
            "calculatorType": 0
        },
        "questionSettings": {
            "randomQuestions": 0,
            "randomAnswers": 0,
            "showQuestionScore": 0
        },
        "displayMessageSettings": {
            "sectionEndPopUp": 0,
            "sectionTimeLeftAlert": 0,
            "candidateFeedback": 0
        },
        "windowViolationSettings": {
            "copyPaste": 0,
            "displayViolationSettings": {
                "displayViolationPopUp": 0,
                "terminateTestOnWindowViolation": 0,
                "terminateTestAfterViolationCount": 0
            }
        },
        "imageProctoringSettings": {
            "terminateTestOnImageViolation": 0,
            "terminateTestAfterViolationCount": 0
        },
        "emailSettings": {
            "sendTestReportEmailToCandidate": 0
        }
    },
    "errors": null
}
Modified at 2025-08-19 13:31:34
Previous
Retrieve a test
Next
Update Test Settings
Built with