> ## Documentation Index
> Fetch the complete documentation index at: https://docs.docketqa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Module

Retrieve a specific module by its ID, including all of its steps and usage information.

<ParamField path="module_id" type="integer" required>
  The ID of the module to retrieve.
</ParamField>

## Response

<ResponseField name="module" type="object">
  The module object.

  <Expandable title="Properties">
    <ResponseField name="id" type="integer">
      The unique ID of the module.
    </ResponseField>

    <ResponseField name="title" type="string">
      The module name.
    </ResponseField>

    <ResponseField name="type" type="string">
      Always `"step_module"` for modules.
    </ResponseField>

    <ResponseField name="status" type="string">
      The module status (e.g. `"active"`).
    </ResponseField>

    <ResponseField name="company_id" type="integer">
      Your company ID.
    </ResponseField>

    <ResponseField name="test_blueprint_category_id" type="integer">
      The test suite ID, if set.
    </ResponseField>

    <ResponseField name="test_blueprint_category_name" type="string">
      The name of the test suite, if set.
    </ResponseField>

    <ResponseField name="folder_path" type="string">
      The folder path of the module.
    </ResponseField>

    <ResponseField name="test_steps" type="object[]">
      The list of steps in this module.

      <Expandable title="Step properties">
        <ResponseField name="id" type="integer">
          The unique step ID.
        </ResponseField>

        <ResponseField name="step_number" type="integer">
          Position of this step in the sequence.
        </ResponseField>

        <ResponseField name="type" type="string">
          The step type (see [step types](/api-reference/introduction#step-types) for all values).
        </ResponseField>

        <ResponseField name="action" type="string">
          The step instruction.
        </ResponseField>

        <ResponseField name="use_vision" type="boolean">
          Whether vision is enabled for this step.
        </ResponseField>

        <ResponseField name="test_blueprint_module_id" type="integer">
          The referenced module ID (for `step_module` steps).
        </ResponseField>

        <ResponseField name="api_request" type="object">
          The API request configuration (for `api` steps).
        </ResponseField>

        <ResponseField name="trigger_run_config" type="object">
          The trigger run configuration (for `trigger_run` steps).
        </ResponseField>

        <ResponseField name="disable_self_healing" type="boolean">
          Whether self-healing is disabled.
        </ResponseField>

        <ResponseField name="click_count" type="integer">
          Number of clicks for this step.
        </ResponseField>

        <ResponseField name="hold_start_duration" type="number">
          Hold duration before the action.
        </ResponseField>

        <ResponseField name="hold_end_duration" type="number">
          Hold duration after the action.
        </ResponseField>

        <ResponseField name="assert_images_count" type="integer">
          Number of assertion images captured.
        </ResponseField>

        <ResponseField name="attached_file_ids" type="integer[]">
          IDs of files attached to this step.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="test_blueprints_using_module" type="object[]">
      List of test blueprints that reference this module.
    </ResponseField>

    <ResponseField name="usage_count" type="integer">
      Number of tests using this module.
    </ResponseField>

    <ResponseField name="created_at" type="string">
      ISO 8601 timestamp of when the module was created.
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      ISO 8601 timestamp of the last update.
    </ResponseField>
  </Expandable>
</ResponseField>

### Example response

```json theme={null}
{
  "module": {
    "id": 962,
    "title": "Login Setup",
    "type": "step_module",
    "status": "active",
    "company_id": 23,
    "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"
  }
}
```