Skip to main content
GET
/
api
/
v2
/
teams
/
{teamKey}
Get team
curl --request GET \
  --url https://app.launchdarkly.com/api/v2/teams/{teamKey} \
  --header 'Authorization: <api-key>'
{
  "description": "Description for this team.",
  "key": "team-key-123abc",
  "name": "Example team",
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "_creationDate": "1648671956143",
  "_links": {
    "parent": {
      "href": "/api/v2/teams",
      "type": "application/json"
    },
    "roles": {
      "href": "/api/v2/teams/example-team/roles",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/teams/example-team",
      "type": "application/json"
    }
  },
  "_lastModified": "1648672446072",
  "_version": 3,
  "_idpSynced": true,
  "roleAttributes": "{\"developerProjectKey\": [\"default\"]}",
  "roles": {
    "totalCount": 1,
    "items": [
      {
        "key": "role-key-123abc",
        "name": "Example role",
        "projects": {
          "totalCount": 1,
          "items": [
            {
              "_links": {
                "environments": {
                  "href": "/api/v2/projects/example-project/environments",
                  "type": "application/json"
                },
                "self": {
                  "href": "/api/v2/projects/example-project",
                  "type": "application/json"
                }
              },
              "key": "project-key-123abc",
              "name": "Example project"
            }
          ]
        },
        "appliedOn": "1648672018410"
      }
    ],
    "_links": {
      "self": {
        "href": "/api/v2/teams/example-team/roles?limit=25",
        "type": "application/json"
      }
    }
  },
  "members": {
    "totalCount": 15
  },
  "projects": {
    "totalCount": 1,
    "items": [
      {
        "_links": {
          "environments": {
            "href": "/api/v2/projects/example-project/environments",
            "type": "application/json"
          },
          "self": {
            "href": "/api/v2/projects/example-project",
            "type": "application/json"
          }
        },
        "key": "project-key-123abc",
        "name": "Example project"
      }
    ]
  },
  "maintainers": {
    "totalCount": 1,
    "items": [
      {
        "_id": "569f183514f4432160000007",
        "_links": {
          "self": {
            "href": "/api/v2/members/569f183514f4432160000007",
            "type": "application/json"
          }
        },
        "email": "ariel@acme.com",
        "firstName": "Ariel",
        "lastName": "Flores",
        "role": "reader"
      }
    ],
    "_links": {
      "self": {
        "href": "/api/v2/teams/example-team/maintainers?limit=20",
        "type": "application/json"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
teamKey
string<string>
required

The team key.

Query Parameters

​
expand
string<string>

A comma-separated list of properties that can reveal additional information in the response.

Response

Teams response

​
description
string

A description of the team

Example:

"Description for this team."

​
key
string

The team key

Example:

"team-key-123abc"

​
name
string

A human-friendly name for the team

Example:

"Example team"

​
_access
object

Details on the allowed and denied actions for this team

​
_creationDate
integer<int64>

Timestamp of when the team was created

Example:

"1648671956143"

​
_links
object

The location and content type of related resources

Example:
{
  "parent": {
    "href": "/api/v2/teams",
    "type": "application/json"
  },
  "roles": {
    "href": "/api/v2/teams/example-team/roles",
    "type": "application/json"
  },
  "self": {
    "href": "/api/v2/teams/example-team",
    "type": "application/json"
  }
}
​
_lastModified
integer<int64>

Timestamp of when the team was most recently updated

Example:

"1648672446072"

​
_version
integer

The team version

Example:

3

​
_idpSynced
boolean

Whether the team has been synced with an external identity provider (IdP). Team sync is available to customers on an Enterprise plan.

Example:

true

​
roleAttributes
object

A map of role attributes for the team

Example:

"{\"developerProjectKey\": [\"default\"]}"

​
roles
object

Paginated list of the custom roles assigned to this team. Only included if specified in the expand query parameter.

​
members
object

Details on the total count of members that belong to the team. Only included if specified in the expand query parameter.

​
projects
object

Paginated list of the projects that the team has any write access to. Only included if specified in the expand query parameter.

​
maintainers
object

Paginated list of the maintainers assigned to this team. Only included if specified in the expand query parameter.