Skip to main content
GET
GET /v1/teams/{id}

Retrieve a Team

Get a single team by its unique ID or fully qualified name.

Get by ID

id
string
required
UUID of the team to retrieve.
fields
string
Comma-separated list of fields to include (e.g., users,parents,children,policies,domains,owners).
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/teams/name/{fqn} to retrieve by fully qualified name.
fqn
string
required
Fully qualified name of the team (e.g., Accounting).
fields
string
Comma-separated list of fields to include: users, parents, children, policies, domains, owners.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/teams/{id}

Returns

Returns a team object with all requested fields populated.

Response

id
string
Unique identifier for the team (UUID format).
name
string
Team name.
fullyQualifiedName
string
Fully qualified name (same as name for teams).
displayName
string
Human-readable display name.
teamType
string
Type of team (Group, Department, Division, BusinessUnit, Organization).
description
string
Description of the team in Markdown format.
parents
array
Parent team references. Only included when fields contains parents.
users
array
Users belonging to this team. Only included when fields contains users.
children
array
Child team references. Only included when fields contains children.
policies
array
Policy references. Only included when fields contains policies.
owners
array
List of owners. Only included when fields contains owners.
domains
array
Domain assignments. Only included when fields contains domains.
version
number
Version number for the entity.

Error Handling