Skip to main content
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>",
    "company_id": 123,
    "browser_zoom": 123,
    "viewport_width": 123,
    "viewport_height": 123,
    "test_steps": [
      {
        "id": 123,
        "step_number": 123,
        "type": "<string>",
        "action": "<string>",
        "use_vision": true,
        "api_request": {}
      }
    ],
    "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.
​
module_id
integer
required
The ID of the module to retrieve.
​
module
object
The module object.

​
Example response

{
  "module": {
    "id": 962,
    "title": "Login Setup",
    "type": "step_module",
    "status": "active",
    "company_id": 23,
    "browser_zoom": 1.0,
    "viewport_width": 1900,
    "viewport_height": 1200,
    "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,
        "api_request": null
      }
    ],
    "created_at": "2025-12-13T18:53:37.588258+00:00",
    "updated_at": "2025-12-13T18:53:37.588265+00:00"
  }
}