Groups

Add employees to groups

POST/v1/groups/add-employees

Puts every employee you send into every group you send. Employees already in a group stay as they are, so sending the same request again is safe. Programs that target these groups, or the groups above them, start including the new members straight away. Nothing changes unless every group and employee is found and active.

Needs a key with the group:write scope.

Body

groupIdsarray of strings
The groups, up to 50.
employeeIdsarray of strings
The employees, up to 1,000. Repeats are ignored.

Response

200: How many memberships were made.

addedinteger
Memberships this request made. Employees already in a group aren't counted.
groupsarray of objects
Each group you sent, in the same order.

Errors

400REQUEST_BODY_INVALID: The body has a field that is unknown, missing or out of range.
401API_KEY_INVALID: The key is missing, wrong, expired or revoked.
403API_KEY_SCOPE_MISSING: The key is valid but wasn't given the scope this endpoint needs. PLAN_UPGRADE_REQUIRED: Your plan doesn't include the API. COMPANY_CLOSED: Your company has closed its Teambrite account.
404GROUP_NOT_FOUND: Your company has no active group with this ID. EMPLOYEE_NOT_FOUND: No employee in your company has this ID.
411REQUEST_LENGTH_REQUIRED: The request didn't declare its length.
413REQUEST_TOO_LARGE: The body is over 1 MB.
422EMPLOYEE_INACTIVE: The employee is no longer active.
429API_KEY_RATE_LIMITED: The key is over 600 requests a minute.

Archive a group

Retire a group nobody uses any more.

Remove employees from groups

Take several people out of several groups at once.

Request

curl -X POST "https://api.teambrite.com/v1/groups/add-employees" \
  -H "Authorization: Bearer $TEAMBRITE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "groupIds": [
      "grp_T6hW3nJqM9xBc2KvLd5Rf8Zp",
      "grp_R4mW8cTqZ2nLx6VbK9hJd3Fs"
    ],
    "employeeIds": [
      "emp_LssEG8crOK3xrxCVx1nS6jy7",
      "emp_YY4BTQjWrhH4sQL1dRwjTpBw"
    ]
  }'

This changes real data, so run it from your own code.

Response

{
  "added": 3,
  "groups": [
    {
      "groupId": "grp_T6hW3nJqM9xBc2KvLd5Rf8Zp",
      "added": 1
    },
    {
      "groupId": "grp_R4mW8cTqZ2nLx6VbK9hJd3Fs",
      "added": 2
    }
  ]
}