Get Module
curl --request GET \
--url https://api.docketqa.com/modules/{module_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.docketqa.com/modules/{module_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.docketqa.com/modules/{module_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.docketqa.com/modules/{module_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.docketqa.com/modules/{module_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.docketqa.com/modules/{module_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.docketqa.com/modules/{module_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"module": {
"id": 123,
"title": "<string>",
"type": "<string>",
"status": "<string>",
"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,
"hold_start_duration": 123,
"hold_end_duration": 123,
"assert_images_count": 123,
"attached_file_ids": [
123
]
}
],
"test_blueprints_using_module": [
{}
],
"usage_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}Modules
Get Module
GET
/
modules
/
{module_id}
Get Module
curl --request GET \
--url https://api.docketqa.com/modules/{module_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.docketqa.com/modules/{module_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.docketqa.com/modules/{module_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.docketqa.com/modules/{module_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.docketqa.com/modules/{module_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.docketqa.com/modules/{module_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.docketqa.com/modules/{module_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"module": {
"id": 123,
"title": "<string>",
"type": "<string>",
"status": "<string>",
"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,
"hold_start_duration": 123,
"hold_end_duration": 123,
"assert_images_count": 123,
"attached_file_ids": [
123
]
}
],
"test_blueprints_using_module": [
{}
],
"usage_count": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}Retrieve a specific module by its ID, including all of its steps and usage information.
integer
required
The ID of the module to retrieve.
Response
object
The module object.
Show Properties
Show Properties
integer
The unique ID of the module.
string
The module name.
string
Always
"step_module" for modules.string
The module status (e.g.
"active").integer
Your company ID.
integer
The test suite ID, if set.
string
The name of the test suite, if set.
string
The folder path of the module.
object[]
The list of steps in this module.
Show Step properties
Show Step properties
integer
The unique step ID.
integer
Position of this step in the sequence.
string
The step type (see step types for all values).
string
The step instruction.
boolean
Whether vision is enabled for this step.
integer
The referenced module ID (for
step_module steps).object
The API request configuration (for
api steps).object
The trigger run configuration (for
trigger_run steps).boolean
Whether self-healing is disabled.
integer
Number of clicks for this step.
number
Hold duration before the action.
number
Hold duration after the action.
integer
Number of assertion images captured.
integer[]
IDs of files attached to this step.
object[]
List of test blueprints that reference this module.
integer
Number of tests using this module.
string
ISO 8601 timestamp of when the module was created.
string
ISO 8601 timestamp of the last update.
Example response
{
"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"
}
}
⌘I

