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.
Note: All API endpoints are secured using Role-Based Access Control (RBAC). Ensure that your account has the necessary permissions to retrieve or modify data.
Get project list
Invoking this API will fetch the list of projects associated with your username and access key. This will give you the list of project identifiers for use in other API calls.
This list is paginated; for more information, refer Pagination.
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://test-management.browserstack.com/api/v2/projects?p=1
-
page-number integer
Page number to retrieve which is used as a query parameter. By default, this endpoint returns page 1.
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"
}
],
"info": {
"page": 2,
"page_size": 30,
"count": 4,
"prev": null,
"next": null
}
}
-
name String
Name of your project.
-
identifier Integer
Identifier of your project.
Create a project
Invoke this API to create a new project.
Request Parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects
No parameters required.
Request Body
Request Body
{
"project": {
"name": "Testing project",
"description": "This is a description of this test project."
}
}
-
name* String
The name assigned to the newly created project.
-
description String
A brief overview detailing the project’s purpose.
Response Attributes 200 OK json
Response
{
"success": true,
"project": {
"name": "Testing project",
"identifier": "PR-2224",
"description": "d",
"created_at": "2025-02-20T01:30:50.000Z",
"created_by": "csv.test@email.com",
"team_id": [1]
}
}
-
success Boolean
API call is executed successfully.
-
name String
The name assigned to the newly created project.
-
identifier String
A unique identifier generated for the project.
-
description String
A brief overview detailing the project’s purpose.
-
created_at String
The timestamp when the project was created on BrowserStack servers.
-
created_by String
The user who created the project, identified by their email.
-
team_id Integer
The unique identifier of the team to which the project creator belongs.
Update a project
Invoking this API allows you to update a given project. To update a project, you will need the id of the project.
Request Parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-2223
No parameters required.
Request Body
Request Body
{
"project": {
"name": "Testing the login",
"description": "This is a description of this test project."
}
}
-
name* String
The name assigned to the newly created project.
-
description String
A brief overview detailing the project’s purpose.
Response Attributes 200 OK json
Response
{
"success": true,
"project": {
"name": "Testing the login",
"identifier": "PR-2223",
"description": "dem",
"created_at": "2025-02-18T19:26:41.000Z",
"created_by": "csv.test@email.com",
"team_id": [1,2]
}
}
-
success Boolean
API call is executed successfully.
-
name String
The name assigned to the newly created project.
-
identifier String
A unique identifier generated for the project.
-
description String
A brief overview detailing the project’s purpose.
-
created_at String
The timestamp when the project was created on BrowserStack servers.
-
created_by String
The user who created the project, identified by their email.
-
team_id Integer
The unique identifier of the team to which the project creator belongs.
Get project details
Invoking this API will fetch the details of the project. To ge the project deatils you will need the id of the project.
This list is paginated; for more information, refer Pagination.
Request Parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-2224
-
name* String
The name assigned to the newly created project.
Response Attributes 200 OK json
Response
{
"success": true,
"project": {
"name": "Testing project",
"identifier": "PR-2224",
"description": "d",
"created_at": "2025-02-20T01:30:50.000Z",
"created_by": "csv.test@email.com",
"team_id": [1]
}
}
-
success Boolean
API call is executed successfully.
-
name String
The name assigned to the newly created project.
-
identifier String
A unique identifier generated for the project.
-
description String
A brief overview detailing the project’s purpose.
-
created_at String
The timestamp when the project was created on BrowserStack servers.
-
created_by String
The user who created the project, identified by their email.
-
team_id Integer
The unique identifier of the team to which the project creator belongs.
Delete a project
Invoking this API will delete a project. You will need the id of the project.
Warning: Using the delete API call will permanently remove the project and all the associated data. This action cannot be undone.
Request Parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST https://test-management.browserstack.com/api/v2/projects/PR-1234
-
name* String
The name assigned to the newly created project.
Response Attributes 200 OK json
Response
{
"success": true,
"message": "Project PR-1234 has been deleted successfully"
}
-
success Boolean
API call is executed successfully.
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.