Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
teams
/
{id}
GET /v1/teams/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Teams

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
print(f"{team.fullyQualifiedName}: {team.teamType}")

# Get by ID with fields
team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    fields=["users", "parents", "policies"]
)

# Get by fully qualified name
team = Teams.retrieve_by_name("Accounting")

# Get by name with fields
team = Teams.retrieve_by_name(
    "Accounting",
    fields=["users", "parents", "children"]
)

{
  "id": "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "teamType": "Group",
  "name": "Accounting",
  "fullyQualifiedName": "Accounting",
  "version": 0.1,
  "updatedAt": 1769982623753,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "parents": [
    {
      "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
      "type": "team",
      "name": "Finance",
      "fullyQualifiedName": "Finance",
      "displayName": "Finance",
      "deleted": false
    }
  ],
  "users": [
    {
      "id": "2c4036a5-27d5-4d47-949f-3e8666e9d371",
      "type": "user",
      "name": "andrew_jennings3",
      "fullyQualifiedName": "andrew_jennings3",
      "displayName": "Andrew Jennings",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

​
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}
from metadata.sdk import configure
from metadata.sdk.entities import Teams

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
print(f"{team.fullyQualifiedName}: {team.teamType}")

# Get by ID with fields
team = Teams.retrieve(
    "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
    fields=["users", "parents", "policies"]
)

# Get by fully qualified name
team = Teams.retrieve_by_name("Accounting")

# Get by name with fields
team = Teams.retrieve_by_name(
    "Accounting",
    fields=["users", "parents", "children"]
)

{
  "id": "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "teamType": "Group",
  "name": "Accounting",
  "fullyQualifiedName": "Accounting",
  "version": 0.1,
  "updatedAt": 1769982623753,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "parents": [
    {
      "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
      "type": "team",
      "name": "Finance",
      "fullyQualifiedName": "Finance",
      "displayName": "Finance",
      "deleted": false
    }
  ],
  "users": [
    {
      "id": "2c4036a5-27d5-4d47-949f-3e8666e9d371",
      "type": "user",
      "name": "andrew_jennings3",
      "fullyQualifiedName": "andrew_jennings3",
      "displayName": "Andrew Jennings",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

​
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

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this team
404NOT_FOUNDTeam with given ID or FQN does not exist