Search test folders

get

https://{tenant}.katalon.io/v2/tm/test-folders

Returns a page of folders in the project selected by x-project-id.
Filter by testProjectId to select a repository, not the project header ID.
Use rawPath as the complete folder path for asset changes.
Requires the TestCase:Read permission. This also applies to test-suite folders.

Without includeFields, counts come from the folder record.
Request includeFields=directSubFolderCount to calculate the immediate subfolder count.
This selector does not calculate test-case counts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

RSQL filter. Supported fields include testProjectId, parentId, name, rawPath, and type. URL-encode the expression.

page

integer

≥ 0

Defaults to 0

Zero-based page number.

size

integer

1 to 100

Defaults to 100

Page size. Values above 100 are capped at 100.

sorts

string

Comma-separated field names with optional asc or desc, such as name asc,id desc. Omission applies no explicit sort.

countOnly

boolean

Defaults to false

Request a count without fetching the full page of records.

includeFields

array of strings

Optional comma-separated fields. Use directSubFolderCount to calculate immediate subfolders; omission uses the stored counts.

includeFields

Headers

x-account-id

string

Optional account UUID for selecting account context explicitly.

x-organization-id

int64

Optional organization ID for selecting organization context explicitly.

x-project-id

int64

required

True Platform project ID, not a repository ID.

Responses

401

Authentication is missing or invalid.

403

The caller lacks access or the required permission.

default

The request could not be completed. Inspect the response before retrying a mutation.

Language

Credentials

Basic

base64

URL

Loading…

Response

Choose an example:

application/json

200A page of folders. A repository outside the selected project returns an empty page.

400Invalid filters, fields, action, repository state, or unsupported mutation.