API: Templates
Use the following API methods to request details about templates (field layouts for cases/results)
get_templates
Returns a list of available templates (requires TestRail 5.2 or later).
GET index.php?/api/v2/get_templates/:project_id
:project_id | The ID of the project |
Response content
The response includes an array of templates (field layouts). Each template has a unique ID and a name. The is_default
field is true
for the default template and false
otherwise.
[
{
"id": 1,
"is_default": true,
"name": "Test Case (Text)"
},
{
"id": 2,
"is_default": false,
"name": "Test Case (Steps)"
},
{
"id": 3,
"is_default": false,
"name": "Exploratory Session"
},
..
]
Response codes
200 | Success, the templates are returned as part of the response |
400 | Invalid or unknown project |
403 | No access to the project |