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>"
  ]
}

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.

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.

Show Test blueprint properties

integer

The unique ID of the test blueprint.

title

string

The test name.

type

string

The blueprint type ("integration", "module", or "step_module").

status

string

The test status: "active" or "paused".

device_type

string

The device type ("browser", "android", or "ios").

device_name

string

The device name, if set.

starting_url

string

The starting URL for the test.

starting_prompt

string

The high-level description, if set.

step_count

integer

The number of steps in the test.

test_blueprint_category_id

integer

The test suite this test belongs to.

test_blueprint_category_name

string

The name of the test suite.

last_run

string

ISO 8601 timestamp of the most recent run, or null.

last_status

string

The result of the most recent run ("passed", "failed", "running"), or null.

company_id

integer

Your company ID.

created_by

integer

The ID of the user who created the test.

browser_zoom

number

The browser zoom level.

viewport_width

integer

Browser viewport width in pixels.

viewport_height

integer

Browser viewport height in pixels.

num_retries

integer

Number of automatic retries on failure.

reset_browser_on_retry

boolean

Whether the browser resets on retry.

typing_speed

integer

Typing speed in milliseconds per character, or null for default.

persist_self_healed

boolean

Whether self-healed caches are persisted.

file_download_mode

string

The file download handling mode ("save_only" or "ingest_content").

files

object[]

Files attached to this test.

variables

object[]

Variables defined for this test.

setup_module

integer

The setup module ID, if set.

teardown_module

integer

The teardown module ID, if set.

folder_path

string

The folder path of the test.

created_at

string

ISO 8601 timestamp of when the test was created.

updated_at

string

ISO 8601 timestamp of the last update.

used_by_integration_count

integer

Number of integration tests using this module. Only present when include_usage_count=true and type is module.

pagination

object

Pagination metadata. Only included when using page/per_page or offset/limit parameters.

Show Pagination properties

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"]
}

Get Test Run Create Module

​Query parameters

​Response

​Example response

Query parameters

Response

Example response