Skip to main content
GET
/
test_blueprint
/
list
List Tests
curl --request GET \
  --url https://api.docketqa.com/test_blueprint/list \
  --header 'X-API-KEY: <api-key>'
{
  "test_blueprints": [
    {
      "id": 123,
      "title": "<string>",
      "type": "<string>",
      "status": "<string>",
      "device_type": "<string>",
      "device_name": "<string>",
      "starting_url": "<string>",
      "starting_prompt": "<string>",
      "step_count": 123,
      "test_blueprint_category_id": 123,
      "test_blueprint_category_name": "<string>",
      "last_run": "<string>",
      "last_status": "<string>",
      "company_id": 123,
      "created_by": 123,
      "browser_zoom": 123,
      "viewport_width": 123,
      "viewport_height": 123,
      "num_retries": 123,
      "reset_browser_on_retry": true,
      "typing_speed": 123,
      "persist_self_healed": true,
      "file_download_mode": "<string>",
      "files": [
        {}
      ],
      "variables": [
        {}
      ],
      "setup_module": 123,
      "teardown_module": 123,
      "folder_path": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "used_by_integration_count": 123
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  },
  "subfolders": [
    "<string>"
  ]
}
Retrieve all test blueprints in your account with their last run information.

​
Query parameters

​
type
string
Filter by blueprint type. Must be one of: "integration", "module", "step_module".
​
test_blueprint_category_id
string
Filter by test suite ID. Pass "none" to get tests with no suite.
​
folder_path
string
Filter by folder path. Defaults to "/" (root folder).
​
include_all_folders
boolean
If true, return tests from all folders. Defaults to false.
​
search
string
Search tests by title (case-insensitive partial match).
​
include_usage_count
boolean
If true, include used_by_integration_count for module-type blueprints. Defaults to false.
​
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.

​
Response

​
test_blueprints
object[]
An array of test blueprint 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 or include_all_folders.

​
Example response

{
  "test_blueprints": [
    {
      "id": 446,
      "title": "Randomized Campaign Creation",
      "type": "integration",
      "status": "active",
      "device_type": "browser",
      "device_name": null,
      "starting_url": "https://app.example.com/",
      "starting_prompt": null,
      "step_count": 38,
      "test_blueprint_category_id": 26,
      "test_blueprint_category_name": "Campaigns",
      "last_run": "2025-10-10T21:05:19.847072+00:00",
      "last_status": "failed",
      "company_id": 3,
      "created_by": 5,
      "browser_zoom": 1.0,
      "viewport_width": 1440,
      "viewport_height": 900,
      "num_retries": 0,
      "reset_browser_on_retry": true,
      "typing_speed": null,
      "persist_self_healed": true,
      "file_download_mode": "save_only",
      "files": [],
      "variables": [],
      "setup_module": null,
      "teardown_module": null,
      "folder_path": "/",
      "created_at": "2025-10-07T00:53:44.522824+00:00",
      "updated_at": "2025-10-07T00:54:00.587872+00:00"
    }
  ],
  "subfolders": ["/E2E Tests", "/Smoke Tests"]
}