Skip to main content
GET
/
modules
/
list
List Modules
curl --request GET \
  --url https://api.docketqa.com/modules/list \
  --header 'X-API-KEY: <api-key>'
{
  "modules": [
    {
      "id": 123,
      "title": "<string>",
      "type": "<string>",
      "status": "<string>",
      "step_count": 123,
      "company_id": 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
        }
      ],
      "usage_count": 123,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  },
  "subfolders": [
    "<string>"
  ]
}
Retrieve modules in your account, with optional filtering and step inclusion.

​
Query parameters

​
ids
string
Comma-separated list of module IDs to fetch. Omit to retrieve all modules.
​
with_steps
boolean
Whether to include the full step details (flattened, with nested modules expanded) for each module. Defaults to false.
​
config_key
string
When with_steps=true, scopes each step’s internal cache to a specific execution config. Typically you don’t construct this yourself — the runtime resolves it for you when a run is triggered.
​
test_blueprint_category_id
string
Filter by test suite ID. Pass "none" to get modules with no suite.
​
folder_path
string
Filter by folder path. Defaults to "/" (root folder).
​
include_all_folders
boolean
If true, return modules from all folders. Defaults to false.
​
search
string
Search modules by title (case-insensitive partial match).
​
page
integer
Page number for pagination (1-indexed). Use with per_page.
​
per_page
integer
Number of results per page. Enables pagination when set.
​
offset
integer
Offset for pagination. Use with limit as an alternative to page/per_page.
​
limit
integer
Maximum number of results. Use with offset.

​
Example requests

Fetch all modules without steps: 
GET /modules/list
Fetch specific modules with steps: 
GET /modules/list?ids=962,964&with_steps=true

​
Response

​
modules
object[]
An array of module objects.
​
pagination
object
Pagination metadata. Only included when using page/per_page or offset/limit parameters.
​
subfolders
string[]
List of subfolder paths within the current folder. Not included when using search.

​
Example response

{
  "modules": [
    {
      "id": 962,
      "title": "Login Setup",
      "type": "step_module",
      "status": "active",
      "step_count": 1,
      "company_id": 23,
      "test_blueprint_category_id": null,
      "folder_path": "/",
      "usage_count": 0,
      "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
        }
      ],
      "created_at": "2025-12-13T18:53:37.588258+00:00",
      "updated_at": "2025-12-13T18:53:37.588265+00:00"
    },
    {
      "id": 964,
      "title": "Auth Token Module",
      "type": "step_module",
      "status": "active",
      "step_count": 3,
      "company_id": 23,
      "test_blueprint_category_id": null,
      "folder_path": "/",
      "usage_count": 0,
      "test_steps": [
        {
          "id": 23103,
          "step_number": 1,
          "type": "act",
          "action": "First AI step instructions",
          "use_vision": false,
          "test_blueprint_module_id": null,
          "api_request": null,
          "disable_self_healing": false,
          "click_count": 1
        },
        {
          "id": 23104,
          "step_number": 2,
          "type": "api",
          "action": "",
          "use_vision": false,
          "test_blueprint_module_id": null,
          "api_request": {
            "url": "https://api.example.com/auth",
            "method": "POST",
            "timeout": 60,
            "retries": 1
          },
          "disable_self_healing": false,
          "click_count": 1
        },
        {
          "id": 23105,
          "step_number": 3,
          "type": "assert",
          "action": "Verify auth succeeded",
          "use_vision": false,
          "test_blueprint_module_id": null,
          "api_request": null,
          "disable_self_healing": false,
          "click_count": 1
        }
      ],
      "created_at": "2025-12-13T18:58:45.895773+00:00",
      "updated_at": "2025-12-13T18:58:45.895781+00:00"
    }
  ],
  "subfolders": ["/Auth Modules"]
}