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,
      "browser_zoom": 123,
      "viewport_width": 123,
      "viewport_height": 123,
      "test_steps": [
        {}
      ],
      "usage_count": 123,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}
Retrieve modules in your account, with optional filtering by ID and step inclusion.
​
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 for each module. Defaults to false.

​
Example requests

Fetch all modules without steps: 
GET /modules/list
Fetch specific modules with steps: 
GET /modules/list?ids=962,964&with_steps=true
​
modules
object[]
An array of module objects.

​
Example response

{
  "modules": [
    {
      "id": 962,
      "title": "Login Setup",
      "type": "step_module",
      "status": "active",
      "step_count": 1,
      "company_id": 23,
      "browser_zoom": 1.0,
      "viewport_width": 1900,
      "viewport_height": 1200,
      "usage_count": 0,
      "test_steps": [
        {
          "id": 23101,
          "step_number": 1,
          "type": "act",
          "action": "Navigate to the login page",
          "use_vision": false
        }
      ],
      "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,
      "browser_zoom": 1.0,
      "viewport_width": 1900,
      "viewport_height": 1200,
      "usage_count": 0,
      "test_steps": [
        {
          "id": 23103,
          "step_number": 1,
          "type": "act",
          "action": "First AI step instructions",
          "use_vision": false
        },
        {
          "id": 23104,
          "step_number": 2,
          "type": "api",
          "action": "",
          "use_vision": false,
          "api_request": {
            "url": "https://api.example.com/auth",
            "method": "POST",
            "timeout": 60,
            "retries": 1
          }
        },
        {
          "id": 23105,
          "step_number": 3,
          "type": "assert",
          "action": "Verify auth succeeded",
          "use_vision": false
        }
      ],
      "created_at": "2025-12-13T18:58:45.895773+00:00",
      "updated_at": "2025-12-13T18:58:45.895781+00:00"
    }
  ]
}