UPupguard
userrisk

List teams

Retrieve a list of teams for your organization.

Required API key permissions: User Risk (select when creating API key in Account Settings)

get/user_risk/teams/list

Request

Query parameters

page_sizeinteger

The page size of results to return. If not supplied, default is 100.

page_tokenstring

The page_token from a previous request, use this to get the next page of results.

sort_by'name' | 'user_count'

The field to sort results by. Default is name.

sort_dir'asc' | 'desc'

The direction to sort results. Default is asc.

Response

A list of teams for your organization

next_page_tokenstring

The token to be used to retrieve the next page of results. Will not be returned if there are no more results.

Example response

{
  "next_page_token": "acbd18db4cc2f85cedef654fccc4a4d8",
  "teams": [
    {
      "name": "Engineering",
      "user_count": 50
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.