No Result Found

Project

Projects are organizational structures for Test Management to store and track information about test cases, test runs, and test results of test runs. Use our REST API to access the project list.

Get project list

GET /api/v2/projects

Invoking this API will fetch the list of projects associated with your username and access key. This will give you the project identifier for use in other API calls.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects

No parameters required.

Response Attributes 200 OK json

Response


{
  "success": true,
  "projects": [
    {
     "name": "Pearson Demo",
     "identifier": "PR-1"
   },
   {
     "name": "E-Commerce Checkout Testing",
     "identifier": "PR-2"
   },
   {
     "name": "Responsive Design Validation",
     "identifier": "PR-3"
   },
   {
     "name": "Browser Compatibility Testing",
     "identifier": "PR-4"
   }
  ]
}

  • identifier Integer

    ID of your project.

  • name String

    Name of your project.

Get list of folders in a project

GET /api/v2/projects/{project_id}/folders

Invoking this API will fetch the list of folders in a projects associated with your username and access key. To access the list of folders in a project, you will need the id of the project.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects/PR-54/folders

  • project_id* String

    Identifier of the project.

Response Attributes 200 OK json

Response


{
  "success": true,
  "folders": [
    {
      "id": 1310,
      "name": "Login",
      "parent_id": 1309,
      "sub_folders_count": 1,
      "links": {
        "sub_folders": "/api/v2/projects/PR-54/folders/1310/sub-folders"
      }
    },
    {
      "id": 1312,
      "name": "Logout",
      "parent_id": 1309,
      "sub_folders_count": 0,
      "links": {
        "sub_folders": "/api/v2/projects/PR-54/folders/1312/sub-folders"
      }
    }
  ]
}

  • success Boolean

    API call is executed successfully.

  • folders Array

    This list has information about a specific folder.

    ▶ SHOW VALUES

    • id Integer

      ID of the main folder.

    • name String

      Name of the folder.

    • parent_id Integer

      ID of the parent folder.

    • sub_folders_count Integer

      Number of sub-folders within the main folder.

    • links String

      API endpoint url of the sub-folders.

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

Download Copy Check Circle