---
updatedAt: 2025-10-16T12:51:57.000Z
agentTools:
  projectIndex: https://clayhr.readme.io/llms.txt
---

# Retrieve test details

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "description": "API Documentation",
    "title": "BizMerlinHR REST APIs",
    "version": "1.0",
    "termsOfService": "https://www.clayhr.com/terms-of-service/"
  },
  "tags": [
    {
      "name": "Test",
      "description": "List of APIs for Tests"
    }
  ],
  "paths": {
    "/api/test/details": {
      "get": {
        "tags": [
          "Test"
        ],
        "summary": "Retrieve test details",
        "operationId": "getTestDetailsUsingDynamicFormId",
        "parameters": [
          {
            "name": "dynamicFormId",
            "in": "query",
            "description": "The ID of Test.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "userid",
            "in": "header",
            "description": "The ID of the user to authenticate.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "x-api-key",
            "in": "header",
            "description": "The API key of the user to authenticate.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": {\n        \"dynamicFormId\": \"int\",\n        \"name\": \"string\",\n        \"dynaFormCode\": \"string\",\n        \"description\": \"string\",\n        \"createUserModel\": \"object\",\n        \"createUserViewModel\": {\n            \"userId\": \"int\",\n            \"firstName\": \"string\",\n            \"lastName\": \"string\",\n            \"name\": \"string\",\n            \"phone\": \"int\",\n            \"email\": \"string\",\n            \"status\": \"string\",\n            \"shortName\": \"string\",\n            \"thumbnail\": \"string\",\n            \"gender\": \"string\",\n            \"jobTitle\": \"string\",\n            \"departmentId\": \"int\",\n            \"department\": \"string\",\n            \"profileId\": \"int\",\n            \"profileName\": \"string\",\n            \"timezone\": \"string\",\n            \"userStartDate\": \"int\",\n            \"cellPhone\": \"int\",\n            \"empId\": \"string\",\n            \"allocation\": \"int\",\n            \"userDateFormat\": \"string\",\n            \"star\": \"int\",\n            \"imageName\": \"string\",\n            \"notes\": \"string\",\n            \"im\": \"int\",\n            \"createuserid\": \"int\",\n            \"cid\": \"int\",\n            \"guid\": \"string\",\n            \"hasAccess\": \"int\",\n            \"id\": \"int\"\n        },\n        \"createts\": \"int\",\n        \"updatets\": \"string\",\n        \"cid\": \"int\",\n        \"availability\": \"string\",\n        \"status\": \"string\",\n        \"anonymous\": \"int\",\n        \"helpTextStyle\": \"string\",\n        \"mappedEntity\": \"string\",\n        \"userGroupModel\": \"object\",\n        \"secSequence\": \"string\",\n        \"thresholdScore\": \"int\",\n        \"formType\": \"string\",\n        \"dataFlow\": \"string\",\n        \"showCorrect\": \"boolean\",\n        \"listed\": \"int\",\n        \"publicSummary\": \"boolean\",\n        \"presentationStyle\": \"string\",\n        \"timeLimit\": \"int\",\n        \"attemptLimit\": \"string\",\n        \"layout\": \"string\"\n    },\n    \"Sections\": [\n        {\n            \"sectionId\": \"int\",\n            \"name\": \"string\",\n            \"cid\": \"int\",\n            \"hidden\": \"boolean\",\n            \"dynamicFormId\": \"int\",\n            \"sequence\": \"int\",\n            \"createUserId\": \"int\",\n            \"description\": \"string\",\n            \"dynamicFormItemModelList\": [\n                {\n                    \"dynamicFormItemId\": \"int\",\n                    \"name\": \"string\",\n                    \"sectionId\": \"int\",\n                    \"createUserId\": \"int\",\n                    \"cid\": \"int\",\n                    \"fieldType\": \"string\",\n                    \"optionValues\": \"string\",\n                    \"helpText\": \"string\",\n                    \"createts\": \"int\",\n                    \"dynamicFormId\": \"int\",\n                    \"mappedEntityItem\": \"string\",\n                    \"fieldTypeItem\": \"string\",\n                    \"mandatory\": \"int\",\n                    \"sequence\": \"int\",\n                    \"weightage\": \"string\",\n                    \"expectedValue\": \"string\",\n                    \"correctFeedback\": \"string\",\n                    \"incorrectFeedback\": \"string\",\n                    \"attachmentModel\": \"object\",\n                    \"prefill\": \"string\",\n                    \"dynaFormItemOptionModelList\": [\n\"object\"\n],\n                    \"customListModel\": \"object\",\n                    \"optionRandom\": \"boolean\",\n                    \"numberingStyle\": \"string\"\n                }\n                \n            ],\n            \"assignee\": \"string\",\n            \"userGroupModel\": \"object\",\n            \"attachmentModel\": \"object\",\n            \"assigneeModel\": \"object\",\n            \"sample\": \"string\",\n            \"totalweightage\": \"int\"\n        }\n    ],\n    \"message\": \"string\"\n}"
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"message\": \"Access denied! Either Authorization or x-api-key & userid parameters are not present/valid.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Access denied! Either Authorization or x-api-key & userid parameters are not present/valid."
                    }
                  }
                }
              }
            }
          },
          "409": {
            "description": "409",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"message\": \"Error while getting the Test Details from API.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Error while getting the Test Details from API."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "servers": [
    {
      "url": "//acmecompany.clayhr.com/rm"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "security": []
}
```