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

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

# List first page
teams = Teams.list(limit=50)
for team in teams.data:
    print(f"{team.fullyQualifiedName} ({team.teamType})")

# List all with auto-pagination
for team in Teams.list_all():
    print(f"{team.fullyQualifiedName}")

# Filter by parent team
teams = Teams.list(
    parentTeam="Finance",
    fields=["users", "parents", "policies"],
    limit=50
)

for team in teams.data:
    print(f"{team.fullyQualifiedName}")
    if team.users:
        print(f"  Users: {[u.name for u in team.users]}")
    if team.parents:
        print(f"  Parents: {[p.name for p in team.parents]}")
{
  "data": [
    {
      "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": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 25
  }
}

List Teams

List all teams with optional filtering and pagination.

Query Parameters

parentTeam
string
Filter by parent team name to list only direct children of that team.
limit
integer
default:"10"
Maximum number of results to return (max: 1000000).
before
string
Cursor for backward pagination.
after
string
Cursor for forward pagination.
fields
string
Comma-separated list of fields to include: users, parents, children, policies, domains, owners. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/teams
from metadata.sdk import configure
from metadata.sdk.entities import Teams

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

# List first page
teams = Teams.list(limit=50)
for team in teams.data:
    print(f"{team.fullyQualifiedName} ({team.teamType})")

# List all with auto-pagination
for team in Teams.list_all():
    print(f"{team.fullyQualifiedName}")

# Filter by parent team
teams = Teams.list(
    parentTeam="Finance",
    fields=["users", "parents", "policies"],
    limit=50
)

for team in teams.data:
    print(f"{team.fullyQualifiedName}")
    if team.users:
        print(f"  Users: {[u.name for u in team.users]}")
    if team.parents:
        print(f"  Parents: {[p.name for p in team.parents]}")
{
  "data": [
    {
      "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": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 25
  }
}

Returns

Returns a paginated list of team objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data
array
Array of team objects.
paging
object
Pagination information.

Supported Fields

The following fields can be requested via the fields query parameter:
FieldDescription
usersUsers belonging to the team
parentsParent team references
childrenChild team references
policiesPolicy references attached to the team
domainsDomain assignments for governance
ownersOwner references (users and teams)

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list teams