List Teams

Teams can be listed directly or for a user from the following endpoints:

  • /teams 
    Authorization: Admin
    Parameters
    • includeAccountsCount -boolean(optional)Default: false Example: includeAccountsCount=true
      Include the key that displays the number of accounts assigned to the team.
    • includeUsersCountboolean(optional)Default: false Example: includeUsersCount=true
      Include the key that displays the number of users in the team.
    • filterByAccounts -boolean(optional)Default: false Example: filterByAccounts=true
      All oData query parameters will filter the list of teams based on their account assignment. For example if you pass: “name=’Springfield Nuclear Plant’”, only teams assigned to Springfield Nuclear Plant will be returned.
    • unassigned -boolean(optional)Default: false Example: unassigned=true
      Filter list of teams include ‘Unassigned’, containing accounts with no team.
    • paging -boolean(optional)Default: true Example: paging=false
      Get a non-paginated list of all teams.
  • /users/{id}/teams
    Authorization: Admin, Web, Mobile

Get Teams [GET]

Response 200

Body
{
  "page": 1,
  "pages": 1,
  "count": 5,
  "items": [
    {
      "id": 0,
      "name": "All Users"
    },
    {
      "id": 1,
      "name": "Atlanta Division"
    },
    {
      "id": 2,
      "name": "Process Engineers"
    }
  ]
}

Still need help? Contact Us Contact Us