v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Teams

Get team hierarchy links

List all team hierarchy links that match the provided filters.

get/api/v2/team-hierarchy-links

Query parameters

page[number]integer

Specific page number to return.

page[size]integer

Example:10

Size for a given page. The maximum allowed value is 100.

filter[parent_team]string

Filter by parent team ID

filter[sub_team]string

Filter by sub team ID

Response

Example response

{
  "data": [
    {
      "attributes": {
        "provisioned_by": "system"
      },
      "id": "b8626d7e-cedd-11eb-abf5-da7ad0900001",
      "relationships": {
        "parent_team": {
          "data": {
            "attributes": {
              "handle": "team-handle",
              "name": "Team Name"
            },
            "id": "692e8073-12c4-4c71-8408-5090bd44c9c8",
            "type": "team"
          }
        },
        "sub_team": {
          "data": {
            "attributes": {
              "handle": "team-handle",
              "name": "Team Name"
            },
            "id": "692e8073-12c4-4c71-8408-5090bd44c9c8",
            "type": "team"
          }
        }
      },
      "type": "team_hierarchy_links"
    }
  ],
  "included": [
    {
      "attributes": {
        "handle": "team-handle",
        "name": "Team Name"
      },
      "id": "692e8073-12c4-4c71-8408-5090bd44c9c8",
      "type": "team"
    }
  ],
  "meta": {
    "page": {
      "type": "number_size"
    }
  }
}