Skip to main content
GET
List Modules
Retrieve modules in your account, with optional filtering and step inclusion.

Query parameters

string
Comma-separated list of module IDs to fetch. Omit to retrieve all modules.
boolean
Whether to include the full step details (flattened, with nested modules expanded) for each module. Defaults to false.
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.
string
Filter by test suite ID. Pass "none" to get modules with no suite.
string
Filter by folder path. Defaults to "/" (root folder).
boolean
If true, return modules from all folders. Defaults to false.
Search modules by title (case-insensitive partial match).
integer
Page number for pagination (1-indexed). Use with per_page.
integer
Number of results per page. Enables pagination when set.
integer
Offset for pagination. Use with limit as an alternative to page/per_page.
integer
Maximum number of results. Use with offset.

Example requests

Fetch all modules without steps:
Fetch specific modules with steps:

Response

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

Example response