Get Started
Core Concepts
Running Tests
Test Generation
Integrations
Get Module
curl --request GET \
--url https://api.docketqa.com/modules/{module_id} \
--header 'X-API-KEY: <api-key>'{
"module": {
"id": 123,
"title": "<string>",
"type": "<string>",
"status": "<string>",
"device_type": "<string>",
"device_name": "<string>",
"company_id": 123,
"browser_zoom": 123,
"viewport_width": 123,
"viewport_height": 123,
"test_blueprint_category_id": 123,
"test_blueprint_category_name": "<string>",
"folder_path": "<string>",
"test_steps": [
{
"id": 123,
"step_number": 123,
"type": "<string>",
"action": "<string>",
"use_vision": true,
"test_blueprint_module_id": 123,
"api_request": {},
"trigger_run_config": {},
"disable_self_healing": true,
"click_count": 123,
"hold_start_duration": 123,
"hold_end_duration": 123,
"assert_images_count": 123,
"attached_file_ids": [
123
]
}
],
"test_blueprints_using_module": [
{}
],
"usage_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}Modules
Get Module
GET
/
modules
/
{module_id}
Get Module
curl --request GET \
--url https://api.docketqa.com/modules/{module_id} \
--header 'X-API-KEY: <api-key>'{
"module": {
"id": 123,
"title": "<string>",
"type": "<string>",
"status": "<string>",
"device_type": "<string>",
"device_name": "<string>",
"company_id": 123,
"browser_zoom": 123,
"viewport_width": 123,
"viewport_height": 123,
"test_blueprint_category_id": 123,
"test_blueprint_category_name": "<string>",
"folder_path": "<string>",
"test_steps": [
{
"id": 123,
"step_number": 123,
"type": "<string>",
"action": "<string>",
"use_vision": true,
"test_blueprint_module_id": 123,
"api_request": {},
"trigger_run_config": {},
"disable_self_healing": true,
"click_count": 123,
"hold_start_duration": 123,
"hold_end_duration": 123,
"assert_images_count": 123,
"attached_file_ids": [
123
]
}
],
"test_blueprints_using_module": [
{}
],
"usage_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}Retrieve a specific module by its ID, including all of its steps and usage information.
The ID of the module to retrieve.
Response
The module object.
Show Properties
Show Properties
The unique ID of the module.
The module name.
Always
"step_module" for modules.The module status (e.g.
"active").The device type (
"browser", "android", or "ios").The device name, if set.
Your company ID.
The browser zoom level.
Browser viewport width.
Browser viewport height.
The test suite ID, if set.
The name of the test suite, if set.
The folder path of the module.
The list of steps in this module.
Show Step properties
Show Step properties
The unique step ID.
Position of this step in the sequence.
The step type (see step types for all values).
The step instruction.
Whether vision is enabled for this step.
The referenced module ID (for
step_module steps).The API request configuration (for
api steps).The trigger run configuration (for
trigger_run steps).Whether self-healing is disabled.
Number of clicks for this step.
Hold duration before the action.
Hold duration after the action.
Number of assertion images captured.
IDs of files attached to this step.
List of test blueprints that reference this module.
Number of tests using this module.
ISO 8601 timestamp of when the module was created.
ISO 8601 timestamp of the last update.
Example response
{
"module": {
"id": 962,
"title": "Login Setup",
"type": "step_module",
"status": "active",
"device_type": "browser",
"device_name": null,
"company_id": 23,
"browser_zoom": 1.0,
"viewport_width": 1440,
"viewport_height": 900,
"test_blueprint_category_id": null,
"test_blueprint_category_name": null,
"folder_path": "/",
"usage_count": 0,
"test_blueprints_using_module": [],
"test_steps": [
{
"id": 23101,
"step_number": 1,
"type": "act",
"action": "Navigate to the login page",
"use_vision": false,
"test_blueprint_module_id": null,
"api_request": null,
"trigger_run_config": null,
"disable_self_healing": false,
"click_count": 1,
"hold_start_duration": 0,
"hold_end_duration": 0,
"assert_images_count": 5,
"attached_file_ids": null
}
],
"created_at": "2025-12-13T18:53:37.588258+00:00",
"updated_at": "2025-12-13T18:53:37.588265+00:00"
}
}
⌘I