Groups

List groups

GET/v1/groups

Returns your active departments, teams and other groups. An empty data means nothing matched your search.

Needs a key with the employee:read scope.

Query parameters

searchstring
Only return groups whose name contains this text.
limitinteger1 to 100 · Default 50
How many to return, up to 100.
cursorstring
The nextCursor from the previous page. Leave it out to start from the beginning.

Response

200: One page of groups.

dataarray of objects
Your groups, ordered by ID.
nextCursorstring or null
Pass this as cursor to get the next page. null on the last page. Treat it as opaque.

Errors

400API_QUERY_INVALID: A query parameter, or an ID in the path, is unknown or not in the right form.
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.
429API_KEY_RATE_LIMITED: The key is over 600 requests a minute. COMPANY_RATE_LIMITED: Your company is over its limit of 120 read requests a minute.

Update an employee

Change someone's profile, such as a new start date or email.

Create a group

Add a department, team or other group.

Credentials

Stays in this tab and goes only to the Teambrite API. Requests use your real data. Get API key

Request

curl "https://api.teambrite.com/v1/groups" \
  -H "Authorization: Bearer $TEAMBRITE_API_KEY"

Response

{
  "data": [
    {
      "id": "grp_T6hW3nJqM9xBc2KvLd5Rf8Zp",
      "name": "Engineering",
      "type": "department",
      "parentGroupId": null,
      "memberCount": 42
    }
  ],
  "nextCursor": null
}