QMetry: Fetch QMetry list Projects
qmetry_fetch_qmetry_list_projectsRetrieve a paginated list of QMetry projects with ID, name, key, and archive status. Filter by name or project key to find specific projects.
Instructions
Fetch QMetry projects list including projectID, name, projectKey, isArchived, viewIds and folderPath needed for other operations
Toolset: Projects
Parameters:
projectKey (string): Project key - unique identifier for the project (default: "default")
baseUrl (string): The base URL for the QMetry instance (must be a valid URL)
params (object) required
start (number): Start index for pagination - defaults to 0 (default: 0)
page (number): Page number to return (starts from 1) (default: 1)
limit (number): Number of records (default 10). (default: 10)
filter (string): Filter criteria as JSON string (default '[]') (default: "[]")
Output Description: JSON object containing list of projects details
Use Cases: 1. Get project list to check user how many project access to particular apikey 2. Retrieve available fields of each project list including projectID, name, projectKey, isArchived, viewIds and folderPath needed for other operations 3. Validate project access and permissions
Examples:
Get list of project available to user
{
"params": {
"showArchive": false
}
}Expected Output: Project active/non archived list including some important fields like projectID, name, projectKey, isArchived, viewIds and folderPath needed for other operations
Get projects with custom pagination
{
"params": {
"showArchive": false
},
"page": 1,
"limit": 10,
"start": 0
}Expected Output: List of projects with custom pagination settings
Get not active/archived projects
{
"params": {
"showArchive": true
}
}Expected Output: List of all projects including archived ones (showArchive: true sent in payload)
Filter projects by name
{
"filter": "[{\"value\":\"MAC\",\"type\":\"string\",\"field\":\"name\"}]"
}Expected Output: Filtered list of projects matching the name criteria
Filter projects by project key
{
"filter": "[{\"value\":\"MAC\",\"type\":\"string\",\"field\":\"projectKey\"}]"
}Expected Output: List of projects filtered by project key (e.g. 'MAC', 'UT', etc.)
Hints: 1. Fetch list of projects available to user 2. Use 'default' project key when user doesn't specify one 3. Use params.showArchive: true/false to get archived/non-archived projects, default is false when not provided 4. Pagination supported for large result sets (start, page, limit parameters) 5. Filter parameter should be a JSON string with filter criteria 6. Common filter fields: 'name' (string), 'projectKey' (string)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number to return (starts from 1) | |
| limit | No | Number of records (default 10). | |
| start | No | Start index for pagination - defaults to 0 | |
| filter | No | Filter criteria as JSON string (default '[]') | [] |
| params | Yes | ||
| baseUrl | No | The base URL for the QMetry instance (must be a valid URL) | |
| projectKey | No | Project key - unique identifier for the project | default |