DAdatadog
Teams

Get team hierarchy members

List the direct and inherited members of a team, deduplicated by user. Members of descendant teams are included unless filter[is_direct_only] is true. Datadog support users are always excluded.

Use page[number] and page[size] to paginate through the results. Invalid query parameters return a JSON:API error with status 400. Invalid or unknown team UUIDs return status 404.

get/api/v2/team/{team_id}/members

Request

Path parameters

team_idstring required
Example:692e8073-12c4-4c71-8408-5090bd44c9c8

UUID of the requested root team.

Query parameters

filter[is_direct_only]boolean

Return only direct members. By default, members inherited from descendant teams are also returned.

filter[include_service_accounts]boolean
Example:true

Include service accounts. Datadog support users are always excluded.

filter[keyword]string
Example:alice

Filter by a case-insensitive substring of the user name, handle, or email.

includestring
Example:user,team

Comma-separated resources to include: user and team. The included team is the requested team. Whitespace is trimmed, and duplicate or empty entries are ignored.

sortstring
Example:is_direct,-name

Comma-separated sort fields: name, handle, is_direct, and provisioned_by. Fields are applied in order, each optionally prefixed with - for descending order. By default, team admins come first, followed by other direct members, then inherited members, sorted by name within each group.

page[number]integer

Zero-based page number. Negative values become 0. Defaults to 0.

page[size]integer
Example:100

Requested number of members per page. Defaults to and maxes out at 100.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "direct_role": "member",
        "is_direct": true,
        "provisioned_by": "manual",
        "provisioned_by_id": "00000000-0000-0000-0000-000000000003"
      },
      "id": "UserTeamRelationship:692e8073-12c4-4c71-8408-5090bd44c9c8:00000000-0000-0000-0000-000000000001",
      "relationships": {
        "team": {
          "data": {
            "id": "692e8073-12c4-4c71-8408-5090bd44c9c8",
            "type": "teams"
          }
        },
        "user": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000001",
            "type": "users"
          }
        }
      },
      "type": "user_team_relationship"
    }
  ],
  "included": [
    {
      "id": "00000000-0000-0000-0000-000000000001",
      "type": "users"
    }
  ],
  "links": {
    "first": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "last": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "next": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "prev": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100",
    "self": "https://api.datadoghq.com/api/v2/team/692e8073-12c4-4c71-8408-5090bd44c9c8/members?page%5Bnumber%5D=0&page%5Bsize%5D=100"
  },
  "meta": {
    "page": {
      "limit": 100,
      "total": 2,
      "type": "offset_limit"
    }
  }
}

Changes

Changes to this operation have not been checked yet.