List teams
Return a list of teams.
By default, this returns the first 20 teams. Page through this list with the limit parameter and by following the first, prev, next, and last links in the _links field that returns. If those links do not appear, the pages they refer to don't exist. For example, the first and prev links will be missing from the response on the first page, because there is no previous page and you cannot return to the first page when you are already on the first page.
Filtering teams
LaunchDarkly supports the following fields for filters:
- query is a string that matches against the teams' names and keys. It is not case-sensitive.
- A request with query:abc returns teams with the string abc in their name or key.
- nomembers is a boolean that filters the list of teams who have 0 members
- A request with nomembers:true returns teams that have 0 members
- A request with nomembers:false returns teams that have 1 or more members
Expanding the teams response
LaunchDarkly supports expanding several fields in the "List teams" response. By default, these fields are not included in the response.
To expand the response, append the expand query parameter and add a comma-separated list with any of the following fields:
- members includes the total count of members that belong to the team.
- roles includes a paginated list of the custom roles that you have assigned to the team.
- roleAttributes includes a list of the role attributes that you have assigned to the team.
- projects includes a paginated list of the projects that the team has any write access to.
- maintainers includes a paginated list of the maintainers that you have assigned to the team.
For example, expand=members,maintainers includes the members and maintainers fields in the response.
Query parameters
The number of teams to return in the response. Defaults to 20.
The number of teams to return in the response. Defaults to 20.
Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items.
Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next limit items.
A comma-separated list of filters. Each filter is constructed as field:value.
A comma-separated list of filters. Each filter is constructed as field:value.
A comma-separated list of properties that can reveal additional information in the response.
A comma-separated list of properties that can reveal additional information in the response.
Response
Teams collection response
Example response
{
"items": [
{
"description": "Description for this team.",
"key": "team-key-123abc",
"name": "Example team",
"_access": {
"denied": [
{
"reason": {
"resources": [
"proj/*:env/*;qa_*:/flag/*"
],
"actions": [
"*"
],
"effect": "allow"
}
}
],
"allowed": [
{
"reason": {
"resources": [
"proj/*:env/*;qa_*:/flag/*"
],
"actions": [
"*"
],
"effect": "allow"
}
}
]
},
"_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"
}
},
"_version": 3,
"_idpSynced": true,
"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"
}
]
}
}
],
"_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"
}
}
}
}
],
"_links": {
"self": {
"href": "/api/v2/teams?expand=maintainers%2Cmembers%2Croles%2Cprojects&limit=20",
"type": "application/json"
}
},
"totalCount": 1
}