Get a folder

GET/projects/{project_id}/folders/{folder_id}

Base URL https://arcus.testsigma.com/api/v1

Retrieves the details of a specific folder within a project.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Path parameters

`project_id`	Unique identifier of the project that contains the folder.
`folder_id`	Unique identifier of the folder whose details are requested.

Response attributes

`message`	Status message for the request; may be empty.
`data.folder.id`	Unique identifier of the folder.
`data.folder.name`	Name of the folder.
`data.folder.project_id`	Identifier of the project to which the folder belongs.
`data.folder.children`	Array of child folders, if any.
`data.folder.parent_folder_id`	Identifier of the parent folder, if applicable.
`data.folder.order`	Order index of the folder.

Request

curl -X GET \
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/folders/{folder_id}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/folders/{folder_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/folders/{folder_id}',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response200 OK

{
  "message": "",
  "data": {
    "folder": {
      "id": "e8db64d3-9291-44d9-9e30-69438c272f05",
      "name": "Regression Suite",
      "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
      "children": [],
      "parent_folder_id": "",
      "order": 30
    }
  }
}

Was this page helpful?