Table of Contents
APP AUTOMATE API

Projects

Each project represents a logical grouping of builds executed on BrowserStack. They help you organize your test sessions on BrowserStack. Use our REST API to manage your projects and fetch project details in real-time.

List recent projects

GET /app-automate/projects.json

Retrieve a list of recent projects for your BrowserStack group.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/projects.json"

# Limit the number of projects to be displayed using "limit" parameter
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/projects.json?limit=5"

# Filter projects using "status" parameter
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/projects.json?status=running"
  • limit String

    Specify the number of projects to fetch. The default value is 10, and the maximum value permitted is 100.

  • offset String

    Retrieve a list of projects from a particular point using the offset parameter. Use offset in conjunction with limit parameter.

  • status String

    Filter recent projects based on the project status. The possible values are running, done, timeout, and failed.

Response Attributes 200 OK application/json

Response

[
    {
        "id": 125132,
        "name": "SampleProject",
        "group_id": 3127826,
        "user_id": 3601191,
        "created_at": "2020-03-15T15:10:31.000Z",
        "updated_at": "2020-09-09T07:16:08.000Z",
        "sub_group_id": 0
    },
    {...}
]
  • Array

    List of recent projects

    SHOW VALUES
    • id Integer

      Unique identifier for your project.

    • name String

      Name of your project.

    • group_id Integer

      Your BrowserStack Group ID.

    • user_id Integer

      Your BrowserStack User ID.

    • created_at String

      Timestamp at which project was created on BrowserStack.

    • updated_at String

      Timestamp at which project was last updated on BrowserStack (i.e. last executed test session in the project).

    • sub_group_id Integer

      Your BrowserStack sub-group ID (if applicable).

Get project details

GET /app-automate/projects/{projectID}.json

Get project details, including the list of builds executed under the given project.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api-cloud.browserstack.com/app-automate/projects/125132.json"
  • projectID* String

    Unique identifier for your project.

Response Attributes 200 OK application/json

Response

{
    "project": {
        "id": 125132,
        "name": "SampleProject",
        "group_id": 3127826,
        "user_id": 3601191,
        "created_at": "2020-09-15T18:16:52.000Z",
        "updated_at": "2020-09-15T18:18:00.000Z",
        "sub_group_id": 0,
        "builds": [
            {
                "id": 2511232,
                "name": "SampleBuild",
                "duration": 69,
                "status": "done",
                "tags": null,
                "group_id": 2,
                "user_id": 3601191,
                "automation_project_id": 125132,
                "created_at": "2020-09-15T18:18:00.000Z",
                "updated_at": "2020-09-15T18:19:09.000Z",
                "hashed_id": "dt6d62f6y7107c24e2c40656864b3bfc6u78ff5cbb",
                "delta": true,
                "test_data": {},
                "sub_group_id": 0,
                "framework": "appium"
            },
            {...}
        ]
    }
}
  • project Object

    Details for specified project

    SHOW VALUES
    • id Integer

      Unique identifier for your project.

    • name String

      Name of your project.

    • group_id Integer

      Your BrowserStack Group ID.

    • user_id Integer

      Your BrowserStack User ID.

    • created_at String

      Timestamp at which project was created on BrowserStack.

    • updated_at String

      Timestamp at which project was last updated on BrowserStack (i.e. last executed test session in the project).

    • sub_group_id Integer

      Your BrowserStack sub-group ID (if applicable).

    • builds Array

      List of all builds under the given project.

      SHOW VALUES
      • id Integer

        Unique identifier for your build.

      • name String

        Name of the build.

      • duration Integer

        Total duration of the build execution.

      • status String

        Status of the build. The possible values for build status are :

        Key Value
        running Build is currently running.
        done All test sessions have executed.
        timeout Build timed out as one or more test sessions were idle for 90 seconds.
        failed One or more test sessions encountered errors.
      • group_id Integer

        Your BrowserStack Group ID.

      • user_id Integer

        Your BrowserStack User ID.

      • automation_project_id Integer

        Unique identifer of the project to which the build belongs.

      • created_at String

        Time at which the build execution started.

      • updated_at String

        Time at which the build was last updated (i.e. last executed test session in this build)

      • hashed_id String

        Unique string identifier for your build.

      • sub_group_id Integer

        Your BrowserStack Sub-Group ID (if applicable).

      • framework String

        Name of the test automation framework. This is set to appium.

Update project details

PUT /app-automate/projects/{project_id}.json

You can also update the name of an existing project upon its completion.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X PUT -H "Content-Type: application/json" \
-d "{\"name\":\"<project-name>\"}" \
"https://api-cloud.browserstack.com/app-automate/projects/<project-id>.json"
  • id* String

    ID of the project.

  • name* String

    Updated name of the project.

Response Attributes 200 OK JSON

Response

{
    "project": {
        "id": 125132,
        "name": "SampleProject Updated",
        "group_id": 3127826,
        "user_id": 3601191,
        "created_at": "2020-09-15T18:16:52.000Z",
        "updated_at": "2020-09-15T18:18:00.000Z",
        "sub_group_id": 0,
    }
}
  • project Object

    Details for specified project

    SHOW VALUES

Get status badge key

GET /app-automate/projects/{project-id}/badge_key

You can embed a status badge in READMEs or other web documents. The status badge for a project shows the status of the latest build in that project. Using the badge key, you can also share a public link for the App Automate dashboard to view the latest build and sessions for that project.

For example:
BrowserStackBrowserStackcompletedcompleted

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api.browserstack.com/app-automate/projects/<project-id>/badge_key

Response Attributes 200 OK Text

Response

VnZ6dGxkRGxGc1RIY01iZGZBVjJBNTA2R0s4ZUhiZkg2cnBJSUdWd0xZcz0tLW90d2dTMDRkVW12WVgxN2lJbTN0Y2c9PQ==--d1e0550cd79408089b252faa4a5204b7dc5c2881

Note: Learn more about how to use the generated Badge key to actually generate a Status badge for your project

Delete a project

DELETE /app-automate/projects/{projectID}.json

Delete a project previously created on BrowserStack. Please note that to delete a project, it needs to be empty of any builds and sessions.

Request Parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X DELETE "https://api-cloud.browserstack.com/app-automate/projects/125132.json"
  • projectID* String

    Unique identifier for the project to be deleted.

Response Attributes 200 OK application/json

Response

{
    "status": "ok",
    "message": "Project 125132 was deleted successfully."
}
  • status String

    Status of your delete request.

  • message String

    Confirmation message for successful deletion of the project.

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