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.
• 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.

Create a team. To learn more, read Creating a team.

Expanding the teams response

LaunchDarkly supports four fields for expanding the "Create team" 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.
• 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,roles includes the members and roles fields in the response.

Fetch a team by key.

Expanding the teams response

LaunchDarkly supports four fields for expanding the "Get team" 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.
• 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,roles includes the members and roles fields in the response.

Perform a partial update to a team. Updating a team uses the semantic patch format.

To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch to your Content-Type header. To learn more, read Updates using semantic patch.

Instructions

Semantic patch requests support the following kind instructions for updating teams.

{
  "instructions": [{
    "kind": "addCustomRoles",
    "values": [ "example-custom-role" ]
  }]
}

{
  "instructions": [{
    "kind": "removeCustomRoles",
    "values": [ "example-custom-role" ]
  }]
}

{
  "instructions": [{
    "kind": "addMembers",
    "values": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ]
  }]
}

{
  "instructions": [{
    "kind": "removeMembers",
    "values": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ]
  }]
}

{
  "instructions": [{
    "kind": "replaceMembers",
    "values": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ]
  }]
}

{
  "instructions": [{
    "kind": "addPermissionGrants",
    "actions": [ "updateTeamName", "updateTeamDescription" ],
    "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ]
  }]
}

{
  "instructions": [{
    "kind": "removePermissionGrants",
    "actions": [ "updateTeamName", "updateTeamDescription" ],
    "memberIDs": [ "1234a56b7c89d012345e678f", "507f1f77bcf86cd799439011" ]
  }]
}

{
  "instructions": [{
    "kind": "updateDescription",
    "value": "Updated team description"
  }]
}

{
  "instructions": [{
    "kind": "updateName",
    "value": "Updated team name"
  }]
}

Expanding the teams response

LaunchDarkly supports four fields for expanding the "Update team" 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.
• 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,roles includes the members and roles fields in the response.

Delete a team by key. To learn more, read Delete a team.

Fetch the maintainers that have been assigned to the team. To learn more, read Manage team maintainers.

Add multiple members to an existing team by uploading a CSV file of member email addresses. Your CSV file must include email addresses in the first column. You can include data in additional columns, but LaunchDarkly ignores all data outside the first column. Headers are optional. To learn more, read Manage team members.

Members are only added on a 201 response. A 207 indicates the CSV file contains a combination of valid and invalid entries. A 207 results in no members being added to the team.

On a 207 response, if an entry contains bad input, the message field contains the row number as well as the reason for the error. The message field is omitted if the entry is valid.

Example 207 response:

{
  "items": [
    {
      "status": "success",
      "value": "new-team-member@acme.com"
    },
    {
      "message": "Line 2: empty row",
      "status": "error",
      "value": ""
    },
    {
      "message": "Line 3: email already exists in the specified team",
      "status": "error",
      "value": "existing-team-member@acme.com"
    },
    {
      "message": "Line 4: invalid email formatting",
      "status": "error",
      "value": "invalid email format"
    }
  ]
}

On a 400 response, the message field may contain errors specific to this endpoint.

Example 400 response:

{
  "code": "invalid_request",
  "message": "Unable to process file"
}

Fetch the custom roles that have been assigned to the team. To learn more, read Manage team permissions.