Skip to main content

List Teams

POST 
/team/list

Lists the teams visible to the authenticated user in their company, with each team's place in the org tree: its parent (parentId) and all ancestors (parentTeamIds), its direct children (childTeamIds), whether it is a leaf (isLeaf), and its level with the company's name for that level (levelName). Users with company-wide team access see every team; others see only their downline or visibility-restricted teams, and under impersonation the impersonated user's. Children and leaves are computed from the teams the caller can see, so a team whose child teams are all hidden from the caller is a leaf for that caller. Archived teams are excluded unless showArchived is set. Set leaves to list only leaf teams, the bottom of the org chart, and underTeamId to list only the teams below one team (combine them for the leaves under a team). To report on the lowest teams a user sees, find the user (for example with /search), make the request as that user (impersonating them needs user:login), list with leaves, then report on a returned teamId. Use /team/get for a single team's members and child teams, or /team/downline to list the users under a team.

Request​

Responses​

Success