List folders

GET/projects/{project_id}/folders

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

Retrieves a paginated list of folders associated with a specific 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 whose folders are listed.

Query parameters

page_size Number of folders to return per page.

Response attributes

`message`	Status message for the request; may be empty.
`data.folders[].id`	Unique identifier of the folder.
`data.folders[].name`	Name of the folder.
`data.folders[].project_id`	Identifier of the project to which the folder belongs.
`data.folders[].children`	Array of child folders, if any.
`data.folders[].parent_folder_id`	Identifier of the parent folder, if applicable.
`data.folders[].order`	Order index of the folder.
`page_info.page_size`	Number of items returned in this response.
`page_info.total_count`	Total number of folders available.
`page_info.next`	URL for the next page of results, if available.
`page_info.prev`	URL for the previous page of results, if available.

Request

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

const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/folders', {
  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',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response200 OK

{
  "message": "",
  "data": {
    "folders": [
      {
        "id": "e8db64d3-9291-44d9-9e30-69438c272f05",
        "name": "Regression Suite",
        "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
        "children": [],
        "parent_folder_id": "",
        "order": 40
      },
      {
        "id": "c69216e0-e2a9-401f-9e08-77176abce8c4",
        "name": "Smoke Tests",
        "project_id": "c47ade67-0543-4582-a4a5-b7de447c94f5",
        "children": [],
        "parent_folder_id": "",
        "order": 2
      }
    ]
  },
  "page_info": {
    "page_size": 3,
    "total_count": 2,
    "next": "",
    "prev": ""
  }
}

Was this page helpful?