Manage teams

Get teams

List all the teams present in an organization account on BrowserStack.

GET /user/team_detail

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/team_detail"

No parameter required.

Response attributes `200` `application/json`

Response

{
    "count": 2,
    "team_details": [
        {
            "name": "MobileTesting",
            "created_at": "2021-09-12T14:57:00.000Z",
            "parallels_allocated": {
                "automate": {
                    "val": 5,
                    "type": "Org"
                },
                "app_automate": {
                    "val": 2,
                    "type": "Team"
                }
            },
            "user_count": 1,
            "user_details": [
                {
                    "id": 5105827,
                    "username": "andy_feFhWX",
                    "full_name": "Andy",
                    "email": "andy@acme.com",
                    "role": "user",
                    "organization_name": "Acme Inc.",
                    "product_access": {
                        "live_testing": true,
                        "automate": true,
                        "percy": true,
                        "app_live_testing": false,
                        "app_automate": false
                    }
                }
            ]
        },
        {
            "name": "WebTesting",
            "created_at": "2021-09-12T14:45:01.000Z",
            "parallels_allocated": {
                "automate": {
                    "val": 5,
                    "type": "Org"
                },
                "app_automate": {
                    "val": 2,
                    "type": "Team"
                }
            },
            "user_count": 0,
            "user_details": []
        }
    ]
}

count Integer

Total no of teams in the organization account on BrowserStack.
team_details Object

Details of teams

▶ SHOW VALUES
- name String
  
  Unique identifier of the user.
- created_at String
  
  Username of the user. In case the user status is pending, the username will be empty.
- parallels_allocated Object
  
  Details of parallels allocated
  
  ▶ SHOW VALUES
  - automate Object
    
    Details of parallels allocated for Automate product
    
    ▶ SHOW VALUES
    - val Integer
      
      Count of Automate product parallels that are available for running tests.
    - type String
      
      Specifies whether parallel is allocated to the Team or Organization.
      
      Possible Value Description
      
      Team Team has parallels allocated.
      
      Org Team is sharing the Org’s parallels.
  - app_automate Object
    
    Details of parallels allocated for App Automate product
    
    ▶ SHOW VALUES
    - val Integer
      
      Count of App Automate product parallels that are available for running tests.
    - type String
      
      Specifies whether parallel is allocated to the Team or Organization.
      
      Possible Value Description
      
      Team Team has parallels allocated.
      
      Org Team is sharing the Org’s parallels.
- user_count Integer
  
  Total no of users in the organization account on BrowserStack.
- user_details Object
  
  Details of users that are part of the given Team.
  
  ▶ SHOW VALUES
  - id String
    
    Unique identifier of the user.
  - username String
    
    Username of the user. In case the user status is pending, the username will be empty.
  - full_name String
    
    Full name of the user. In case the user status is pending, the full_name will be empty.
  - email String
    
    Email of the user.
  - role String
    
    Role of the user.
  - organization_name String
    
    Name of the organization account on BrowserStack.
  - teams Array[String]
    
    List of all team to which the user belongs. Note: If the user is part of Organization (and not any Team within the Organization) then teams key is not returned.
  - additional_teams Array[String]
    
    List of additional teams to which the user is assigned. This parameter is available only to some customers. For more details, contact support.
  - product_access Object
    
    Details of product access.
    
    ▶ SHOW VALUES
    - live_testing Boolean
      
      Value is set to true if product-access to Live product is granted to the user.
    - app_live_testing Boolean
      
      Value is set to true if product-access to App Live product is granted to the user.
    - automate Boolean
      
      Value is set to true if product-access to Automate product is granted to the user.
    - app_automate Boolean
      
      Value is set to true if product-access to App Automate product is granted to the user.
    - percy Boolean
      
      Value is set to true if product-access to Percy product is granted to the user.
    - app_percy Boolean
      
      Value is set to true if product-access to App Percy product is granted to the user.

Possible Value	Description
`Team`	Team has parallels allocated.
`Org`	Team is sharing the Org’s parallels.

Possible Value	Description
`Team`	Team has parallels allocated.
`Org`	Team is sharing the Org’s parallels.

Get team details

Returns the details of the specified user. The team_name of the team is the valid unique identifier to fetch the team detail.

GET /user/get_team_details

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/get_team_details?team_name=MobileTesting"

team_name^* String

Name of the team.

Response attributes `200` `application/json`

Response

{
    "name": "MobileTesting",
    "created_at": "2021-09-17T08:14:05.000Z",
    "parallels_allocated": {
        "automate": {
            "val": 2,
            "type": "Team"
        },
        "app_automate": {
            "val": 5,
            "type": "Org"
        }
    },
    "user_count": 0,
    "user_details": []
}

name String

Name of the Team.
created_at String

Timestamp at which Team was created.
parallels_allocated Object

Details of parallels available to the Team for automated testing.

▶ SHOW VALUES
- automate Object
  
  Details of parallels allocated for Automate product
  
  ▶ SHOW VALUES
  - val Integer
    
    Count of Automate product parallels that are available for running tests.
  - type String
    
    Specifies whether parallel is allocated to the Team or Organization.
    
    Possible Value Description
    
    Team Team has parallels allocated.
    
    Org Team is sharing the Org’s parallels.
- app_automate Object
  
  Details of parallels allocated for App Automate product
  
  ▶ SHOW VALUES
  - val Integer
    
    Count of App Automate product parallels that are available for running tests.
  - type String
    
    Specifies whether parallel is allocated to the Team or Organization.
    
    Possible Value Description
    
    Team Team has parallels allocated.
    
    Org Team is sharing the Org’s parallels.
user_count String

Total no of users in the given Team.
user_details Object

Details of users

▶ SHOW VALUES
- id String
  
  Unique identifier of the user.
- username String
  
  Username of the user. In case the user status is pending, the username will be empty.
- full_name String
  
  Full name of the user. In case the user status is pending, the full_name will be empty.
- email String
  
  Email of the user.
- role String
  
  Role of the user.
- organization_name String
  
  Name of the organization account on BrowserStack.
- teams Array[String]
  
  List of all team to which the user belongs. Note: If the user is part of Organization (and not any Team within the Organization) then teams key is not returned.
- additional_teams Array[String]
  
  List of additional teams to which the user is assigned. This parameter is available only to some customers. For more details, contact support.
- product_access Object
  
  Details of product access.
  
  ▶ SHOW VALUES
  - live_testing Boolean
    
    Value is set to true if product-access to Live product is granted to the user.
  - app_live_testing Boolean
    
    Value is set to true if product-access to App Live product is granted to the user.
  - automate Boolean
    
    Value is set to true if product-access to Automate product is granted to the user.
  - app_automate Boolean
    
    Value is set to true if product-access to App Automate product is granted to the user.
  - percy Boolean
    
    Value is set to true if product-access to Percy product is granted to the user.
  - app_percy Boolean
    
    Value is set to true if product-access to App Percy product is granted to the user.

Possible Value	Description
`Team`	Team has parallels allocated.
`Org`	Team is sharing the Org’s parallels.

Possible Value	Description
`Team`	Team has parallels allocated.
`Org`	Team is sharing the Org’s parallels.

Create new team

POST /user/create_team

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api.browserstack.com/user/create_team?team_name=WebTesting"

team_name^* String

Name of team. Minimum 1 and maximum 40 characters are required for team name.

Response attributes `200` `application/json`

Response

{
    "message": "WebTesting successfully created."
}

status_code String

WebTesting successfully created.

Allocate parallels to team

Allocate parallels (for Automate or App Automate product) to teams. Allocated parallels to a team defines the limit of parallel tests that can be run concurrently by members of that team.

PATCH /user/team-parallel-allocation

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X PATCH "https://api.browserstack.com/user/team-parallel-allocation" -d '{"teams": {"WebTesting": 3},"product": "automate"}'

teams^* Object

Object of team names and parallels to be allocated.

product^* String

Specify the product for which team is to be updated.

Possible Value	Description
`automate`	BrowserStack’s Automate product for automated testing of websites.
`app_automate`	BrowserStack’s App Automate product for automated testing of mobile apps.

Response attributes `200` `application/json`

Response

{
    "message": "Parallel test limit updated for teams."
}

status_code String

WebTesting successfully created.

Get team parallels

Get information on current parallel allocation for team(s) in your account.

GET /user/get_team_details

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X GET "https://api.browserstack.com/user/get_team_details"

team_name^* String

Name of the team

Response attributes `200` `application/json`

Response

{
    "message": {
        "MobileTesting": {
            "parallels": {
                "automate": {
                    "val": 1,
                    "type": "Team"
                },
                "app_automate": {
                    "val": 5,
                    "type": "Org"
                }
            }
        },
        "WebTesting": {
            "parallels": {
                "automate": {
                    "val": 2,
                    "type": "Team"
                },
                "app_automate": {
                    "val": 5,
                    "type": "Org"
                }
            }
        }
    }
}

message Array

Details of parallels allocated across Teams

▶ SHOW VALUES
- team_name Object
  
  Details of parallels allocated
  
  ▶ SHOW VALUES
  - automate Object
    
    Details of parallels allocated for Automate product
    
    ▶ SHOW VALUES
    - val Integer
      
      Count of Automate product parallels that are available for running tests.
    - type String
      
      Specifies whether parallel is allocated to the Team or Organization.
      
      Possible Value Description
      
      Team Team has parallels allocated.
      
      Org Team is sharing the Org’s parallels.
  - app_automate Object
    
    Details of parallels allocated for App Automate product
    
    ▶ SHOW VALUES
    - val Integer
      
      Count of App Automate product parallels that are available for running tests.
    - type String
      
      Specifies whether parallel is allocated to the Team or Organization.
      
      Possible Value Description
      
      Team Team has parallels allocated.
      
      Org Team is sharing the Org’s parallels.

Possible Value	Description
`Team`	Team has parallels allocated.
`Org`	Team is sharing the Org’s parallels.

Possible Value	Description
`Team`	Team has parallels allocated.
`Org`	Team is sharing the Org’s parallels.

Allocate licenses to teams

Allocate licenses (for Live or App Live product) to teams. Allocated licenses to a team define the number of users who can access Live or App Live products.

PATCH /user/team-license-allocation

Request parameters

Request

curl -u "USERNAME:ACCESS_KEY" \
-X PATCH "https://api.browserstack.com/user/team-license-allocation" -d '{
    "teams": {
        "TeamA": 1,
         "TeamB": 4
    },
    "product": "live"
}'

teams^* Object

Object of team names and the number of licenses to be allocated.

product^* String

Specify the product for which license is to be updated.

Possible Value	Description
`live`	BrowserStack’s Live product for manual testing of websites and web apps.
`app_live`	BrowserStack’s App Live product for manual testing of mobile apps.

Response attributes `200` `application/json`

Response

{
    "message": "User limits updated for team(s): TeamA, TeamB."
}

status_code String

Licenses successfully allocated.

Delete team

Delete a team.

DELETE /user/delete_team

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X DELETE "https://api.browserstack.com/user/delete_team?team_name=WebTesting"
-H "Content-Type: application/json" \
-d '{"move_to_org": true}'

team_name^* String

Name of the team
move_to_org String

If set to true, all users having primary team as deleted team will be moved to org.
If set to false, all users will be moved as per the response retrieved in the delete team data endpoint.
This parameter is only available to some customers. For more details, contact support.

Response attributes `200` `application/json`

Response

{
    "message": "WebTesting successfully deleted."
}

status_code String

Status code

Note:
If auto user provisioning is enabled, contact your IT Admin for team creation or deletion.

Did this page help you?

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

This page has exactly what I am looking for
This content & code samples are accurate and up-to-date
The content on this page is easy to understand
Other (please tell us more below)

Any additional feedback?

Thank you for your valuable feedback

Manage teams

Get teams

Request parameters

Response attributes 200 application/json

count Integer

team_details Object

name String

created_at String

parallels_allocated Object

automate Object

val Integer

type String

app_automate Object

val Integer

type String

user_count Integer

user_details Object

id String

username String

full_name String

email String

role String

organization_name String

teams Array[String]

additional_teams Array[String]

product_access Object

live_testing Boolean

app_live_testing Boolean

automate Boolean

app_automate Boolean

percy Boolean

app_percy Boolean

Get team details

Request parameters

team_name* String

Response attributes 200 application/json

name String

created_at String

parallels_allocated Object

automate Object

val Integer

type String

app_automate Object

val Integer

type String

user_count String

user_details Object

id String

username String

full_name String

email String

role String

organization_name String

teams Array[String]

additional_teams Array[String]

product_access Object

live_testing Boolean

app_live_testing Boolean

automate Boolean

app_automate Boolean

percy Boolean

app_percy Boolean

Create new team

Request parameters

team_name* String

Response attributes 200 application/json

status_code String

Allocate parallels to team

Request parameters

teams* Object

product* String

Response attributes 200 application/json

status_code String

Get team parallels

Request parameters

team_name* String

Response attributes 200 application/json

message Array

team_name Object

automate Object

Response attributes `200` `application/json`

team_name^* String

Response attributes `200` `application/json`

team_name^* String

Response attributes `200` `application/json`

teams^* Object

product^* String

Response attributes `200` `application/json`

team_name^* String

Response attributes `200` `application/json`

teams^* Object

product^* String

Response attributes `200` `application/json`

team_name^* String

Response attributes `200` `application/json`