Get test plan folder

GET/testplanfolders/{id}

Get details of specific test plan folder

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK

example.ts

import { createConfiguration, TestPlanFoldersApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TestPlanFoldersApi(config);

const result = await api.getTestPlanFolder({
  "id": 123
});
console.log(result);

HTTP

curl --request GET \
  "https://api.testcollab.io/testplanfolders/123?token=$TESTCOLLAB_TOKEN"

Parameters

Name	Location	Type	Required	Description
id	path	number	Yes	Test Plan Folder ID

Response

200 — Selected test plan folder

Field	Type	Required	Description
id	number	Yes	—
project	number	Yes	—
title	string	Yes	—
parent_id	number	Yes	—
sort_order	number	No	—
testplancount	number	No	—
created_by	number	No	—
description	string	No	—
created_at	string	Yes	—
updated_at	string	Yes	—

Illustrative response

{
  "id": 123,
  "project": 123,
  "title": "example",
  "parent_id": 123,
  "sort_order": 123,
  "testplancount": 123,
  "created_by": 123,
  "description": "example",
  "created_at": "example"
}

Errors

Status	Meaning
403	Forbidden

Next steps

• Browse plans and runs
• Authentication
• Handle errors