QTM4J: Get Projects
qtm4j_get_projectsRetrieve and filter QTM4J projects by ID, search text, QMetry status, or pagination to get project details like keys, names, and integration status for use in other operations.
Instructions
Get all projects from QTM4J with optional filtering
Toolset: Projects
Parameters:
projectId (number): Filter by specific project ID
search (string): Search text for project key or project name
qmetryEnabled (boolean): Filter by QMetry enabled status
startAt (number): Zero-indexed starting position for pagination (default: 0)
maxResults (number): Maximum number of results per page (1-100) (default: 100)
Output Description: JSON object containing paginated list of projects with IDs, keys, names, and QMetry status, along with pagination metadata
Use Cases: 1. Discover all projects available in QTM4J instance 2. Get project IDs and keys for reference in other operations 3. Find specific projects by ID 4. Search projects by text in project key or name 5. Filter projects by QMetry integration status 6. List projects with pagination for large QTM4J instances 7. Retrieve complete project details (ID, key, name, avatarUrl, projectTypeKey, qmetryEnabled, favorite) 8. Validate project access and permissions 9. Browse available projects before performing other operations
Examples:
Get all projects (default pagination - first 100)
{}Expected Output: List of all projects with IDs, keys, and names (first 100 projects)
Get the first 10 projects
{
"maxResults": 10
}Expected Output: List of first 10 projects with their details
Get a specific project by ID
{
"projectId": 10000
}Expected Output: Single project with ID 10000 including key, name, and QMetry status
Search projects by text in project key or name
{
"search": "SCRUM"
}Expected Output: Projects matching 'SCRUM' search text in their project keys or names
Get only QMetry-enabled projects
{
"qmetryEnabled": true
}Expected Output: List of projects that have QMetry integration enabled
Get projects with custom pagination (page 2)
{
"startAt": 50,
"maxResults": 50
}Expected Output: Second page of projects (items 51-100) with their details
Search QMetry-enabled projects by text
{
"search": "TEST",
"qmetryEnabled": true
}Expected Output: QMetry-enabled projects containing 'TEST' in their project keys
Hints: 1. Project IDs are numeric (e.g., 10000), project keys are strings (e.g., 'SCRUM') 2. Use 'projectId' parameter to filter by a specific project ID 3. Use 'search' parameter to search by text in project key or project name 4. Use 'qmetryEnabled' parameter to filter projects by QMetry integration status 5. Response contains complete project details: id, key, name, favorite, avatarUrl, projectTypeKey, qmetryEnabled 6. Pagination: startAt is zero-indexed, maxResults max is 100, default is 100 7. Default (no parameters) returns first 100 projects 8. Use 'isLast' in response to check if more pages are available 9. To get next page: increment startAt by maxResults (0 → 100 → 200) 10. Use 'total' in response for total count of matching projects
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Search text for project key or project name | |
| startAt | No | Zero-indexed starting position for pagination | |
| projectId | No | Filter by specific project ID | |
| maxResults | No | Maximum number of results per page (1-100) | |
| qmetryEnabled | No | Filter by QMetry enabled status |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | List of projects | |
| total | Yes | Total number of projects |