---
title: "Get team hierarchy links"
method: GET
path: "/api/v2/team-hierarchy-links"
tags: ["Teams"]
---

# Get team hierarchy links

`GET /api/v2/team-hierarchy-links`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/team-hierarchy-links`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `teams_read`

List all team hierarchy links that match the provided filters.

## Query parameters

- `page[number]` integer
- `page[size]` integer
- `filter[parent_team]` string
- `filter[sub_team]` string

## Response `200`

OK

- TeamHierarchyLinksResponse: Team hierarchy links response
  - `data` TeamHierarchyLink[]: Team hierarchy links response data
    - `attributes` TeamHierarchyLinkAttributes, required: Team hierarchy link attributes
      - `created_at` string, date-time, required: Timestamp when the team hierarchy link was created
      - `provisioned_by` string, required: The provisioner of the team hierarchy link
    - `id` string, required: The team hierarchy link's identifier
    - `relationships` TeamHierarchyLinkRelationships: Team hierarchy link relationships
      - `parent_team` TeamHierarchyLinkTeamRelationship, required: Team hierarchy link team relationship
        - `data` TeamHierarchyLinkTeam, required: Team hierarchy links connect different teams. This represents team objects that are connected by the team hierarchy link.
          - `attributes` TeamHierarchyLinkTeamAttributes: Team hierarchy links connect different teams. This represents attributes from teams that are connected by the team hierarchy link.
            - `avatar` string, nullable: The team's avatar
            - `banner` integer: The team's banner
            - `handle` string, required: The team's handle
            - `is_managed` boolean: Whether the team is managed
            - `is_open_membership` boolean: Whether the team has open membership
            - `link_count` integer: The number of links for the team
            - `name` string, required: The team's name
            - `summary` string, nullable: The team's summary
            - `user_count` integer: The number of users in the team
          - `id` string, required: The team's identifier
          - `type` 'team', required: Team type
      - `sub_team` TeamHierarchyLinkTeamRelationship, required: Team hierarchy link team relationship
        - `data` TeamHierarchyLinkTeam, required: Team hierarchy links connect different teams. This represents team objects that are connected by the team hierarchy link.
          - `attributes` TeamHierarchyLinkTeamAttributes: Team hierarchy links connect different teams. This represents attributes from teams that are connected by the team hierarchy link.
            - `avatar` string, nullable: The team's avatar
            - `banner` integer: The team's banner
            - `handle` string, required: The team's handle
            - `is_managed` boolean: Whether the team is managed
            - `is_open_membership` boolean: Whether the team has open membership
            - `link_count` integer: The number of links for the team
            - `name` string, required: The team's name
            - `summary` string, nullable: The team's summary
            - `user_count` integer: The number of users in the team
          - `id` string, required: The team's identifier
          - `type` 'team', required: Team type
    - `type` 'team_hierarchy_links', required: Team hierarchy link type
  - `included` TeamHierarchyLinkTeam[]: Included teams
    - `attributes` TeamHierarchyLinkTeamAttributes: Team hierarchy links connect different teams. This represents attributes from teams that are connected by the team hierarchy link.
      - `avatar` string, nullable: The team's avatar
      - `banner` integer: The team's banner
      - `handle` string, required: The team's handle
      - `is_managed` boolean: Whether the team is managed
      - `is_open_membership` boolean: Whether the team has open membership
      - `link_count` integer: The number of links for the team
      - `name` string, required: The team's name
      - `summary` string, nullable: The team's summary
      - `user_count` integer: The number of users in the team
    - `id` string, required: The team's identifier
    - `type` 'team', required: Team type
  - `links` TeamsHierarchyLinksResponseLinks: When querying team hierarchy links, a set of links for navigation between different pages is included
    - `first` string, nullable: Link to the first page.
    - `last` string, nullable: Link to the last page.
    - `next` string, nullable: Link to the next page.
    - `prev` string, nullable: Link to the previous page.
    - `self` string: Link to the current object.
  - `meta` TeamsHierarchyLinksResponseMeta: Metadata that is included in the response when querying the team hierarchy links
    - `page` TeamsHierarchyLinksResponseMetaPage: Metadata related to paging information that is included in the response when querying the team hierarchy links
      - `first_number` integer: First page number.
      - `last_number` integer: Last page number.
      - `next_number` integer, nullable: Next page number.
      - `number` integer: Page number.
      - `prev_number` integer, nullable: Previous page number.
      - `size` integer: Page size.
      - `total` integer: Total number of results.
      - `type` string: Pagination type.

## Other responses

- `403`: Forbidden
- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)