Add Users to Team

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

Important With Circle IconCreated with Sketch.Important

Atlas limits Atlas user membership to a maximum of 250 Atlas users per team.

POST /orgs/{ORG-ID}/teams/{TEAM-ID}/users
Path ElementRequired/OptionalDescription
ORG-IDRequired.The unique identifier for the organization you want to associate the team with.
TEAM-IDRequiredThe name of the team you want to add users to.

A boolean that specifies whether or not to wrap the response in an envelope.

Defaults to false.


A boolean that specifies whether or not to return a "pretty-printed" JSON document.

Defaults to false.

Specify an array of documents, where each document represents one user you want to add to the team. You must specify an array even if you are only associating a single user to the team.

idstringThe unique ID of the user you want to add to the team

The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.

resultsobject arrayIncludes one object for each item detailed in the results array section.
linksobject arrayIncludes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCountnumberCount of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

Each element in the result array is one user added to the team.

countrystringThe ISO 3166 Alpha-2 country code associated to the user.
emailAddressstringThe email address associated to the user.
firstNamestringThe first name of the user.
idstringThe unique identifier for the team.
lastNamestringThe last name of the user.
linksobject arrayOne or more links to sub-resources and/or related resources. The relation-types between URL s are explained in the Web Linking Specification.
mobileNumberstringThe phone number associated to the user.
rolesarrayEach object in the roles array represents the Atlas organization role the user has for the associated org_id
roles.orgIdstringID of the organization where the user has the assigned roles.roleName organization role.
roles.roleNamestringThe organization role assigned to the user for the specified roles.orgId.
teamsIdarrayArray of string IDs for each team the user is a member of.
usernamestringUsername associated to the user.
curl -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request POST "{ORG-ID}/teams/{TEAM-ID}/users?pretty=true" \
--data '[{ "id" : "{USER-ID}" }]'
"links": [
"href": "{ORG-ID}/teams/{TEAM-ID}/users?pretty=true",
"rel": "self"
"results": [
"country": "US",
"emailAddress": "",
"firstName": "Atlas",
"id": "{USER-ID}",
"lastName": "user",
"links": [
"href": "{USER-ID}",
"rel": "self"
"mobileNumber": "5555550100",
"roles": [
"orgId": "{ORG-ID}",
"roleName": "ORG_MEMBER"
"teamIds": [
"username": ""
"totalCount": 1
Give Feedback