Get team

GET

/api/v2/teams/:teamKey

Fetch a team by key.

Expanding the teams response

LaunchDarkly supports several 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.
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,roles includes the members and roles fields in the response.

Path parameters

teamKeystringRequired

The team key.

Query parameters

expandstringOptional

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

Response

Teams response

descriptionstringOptional

A description of the team

keystringOptional

The team key

namestringOptional

A human-friendly name for the team

_accessobjectOptional

Details on the allowed and denied actions for this team

_creationDatelongOptional

Timestamp of when the team was created

_linksmap from strings to objectsOptional

The location and content type of related resources

_lastModifiedlongOptional

Timestamp of when the team was most recently updated

_versionintegerOptional

The team version

_idpSyncedbooleanOptional

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

roleAttributesmap from strings to lists of stringsOptional

A map of role attributes for the team

rolesobjectOptional

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

membersobjectOptional

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

projectsobjectOptional

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

maintainersobjectOptional

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

Errors

GET

1 curl https://app.launchdarkly.com/api/v2/teams/teamKey \
2      -H "Authorization: <apiKey>"

200Retrieved

1 {
2   "description": "Description for this team.",
3   "key": "team-key-123abc",
4   "name": "Example team",
5   "_access": {
6     "denied": [
7       {
8         "action": "action",
9         "reason": {
10           "effect": "allow"
11         }
12       }
13     ],
14     "allowed": [
15       {
16         "action": "action",
17         "reason": {
18           "effect": "allow"
19         }
20       }
21     ]
22   },
23   "_creationDate": 1000000,
24   "_links": {
25     "parent": {
26       "href": "/api/v2/teams",
27       "type": "application/json"
28     },
29     "roles": {
30       "href": "/api/v2/teams/example-team/roles",
31       "type": "application/json"
32     },
33     "self": {
34       "href": "/api/v2/teams/example-team",
35       "type": "application/json"
36     }
37   },
38   "_lastModified": 1000000,
39   "_version": 3,
40   "_idpSynced": true,
41   "roleAttributes": {
42     "key": [
43       "value"
44     ]
45   },
46   "roles": {
47     "totalCount": 1,
48     "items": [
49       {
50         "key": "role-key-123abc",
51         "name": "Example role"
52       }
53     ],
54     "_links": {
55       "self": {
56         "href": "/api/v2/teams/example-team/roles?limit=25",
57         "type": "application/json"
58       }
59     }
60   },
61   "members": {
62     "totalCount": 15
63   },
64   "projects": {
65     "totalCount": 1,
66     "items": [
67       {
68         "_id": "57be1db38b75bf0772d11383",
69         "_links": {
70           "environments": {
71             "href": "/api/v2/projects/example-project/environments",
72             "type": "application/json"
73           },
74           "self": {
75             "href": "/api/v2/projects/example-project",
76             "type": "application/json"
77           }
78         },
79         "key": "project-key-123abc",
80         "name": "Example project"
81       }
82     ]
83   },
84   "maintainers": {
85     "totalCount": 1,
86     "items": [
87       {
88         "_links": {
89           "self": {
90             "href": "/api/v2/members/569f183514f4432160000007",
91             "type": "application/json"
92           }
93         },
94         "_id": "569f183514f4432160000007",
95         "role": "reader",
96         "email": "ariel@acme.com",
97         "firstName": "Ariel",
98         "lastName": "Flores"
99       }
100     ],
101     "_links": {
102       "self": {
103         "href": "/api/v2/teams/example-team/maintainers?limit=5",
104         "type": "application/json"
105       }
106     }
107   }
108 }

Get team custom roles

Up Next

Built with

1	curl https://app.launchdarkly.com/api/v2/teams/teamKey \
2	-H "Authorization: <apiKey>"

1	{
2	"description": "Description for this team.",
3	"key": "team-key-123abc",
4	"name": "Example team",
5	"_access": {
6	"denied": [
7	{
8	"action": "action",
9	"reason": {
10	"effect": "allow"
11	}
12	}
13	],
14	"allowed": [
15	{
16	"action": "action",
17	"reason": {
18	"effect": "allow"
19	}
20	}
21	]
22	},
23	"_creationDate": 1000000,
24	"_links": {
25	"parent": {
26	"href": "/api/v2/teams",
27	"type": "application/json"
28	},
29	"roles": {
30	"href": "/api/v2/teams/example-team/roles",
31	"type": "application/json"
32	},
33	"self": {
34	"href": "/api/v2/teams/example-team",
35	"type": "application/json"
36	}
37	},
38	"_lastModified": 1000000,
39	"_version": 3,
40	"_idpSynced": true,
41	"roleAttributes": {
42	"key": [
43	"value"
44	]
45	},
46	"roles": {
47	"totalCount": 1,
48	"items": [
49	{
50	"key": "role-key-123abc",
51	"name": "Example role"
52	}
53	],
54	"_links": {
55	"self": {
56	"href": "/api/v2/teams/example-team/roles?limit=25",
57	"type": "application/json"
58	}
59	}
60	},
61	"members": {
62	"totalCount": 15
63	},
64	"projects": {
65	"totalCount": 1,
66	"items": [
67	{
68	"_id": "57be1db38b75bf0772d11383",
69	"_links": {
70	"environments": {
71	"href": "/api/v2/projects/example-project/environments",
72	"type": "application/json"
73	},
74	"self": {
75	"href": "/api/v2/projects/example-project",
76	"type": "application/json"
77	}
78	},
79	"key": "project-key-123abc",
80	"name": "Example project"
81	}
82	]
83	},
84	"maintainers": {
85	"totalCount": 1,
86	"items": [
87	{
88	"_links": {
89	"self": {
90	"href": "/api/v2/members/569f183514f4432160000007",
91	"type": "application/json"
92	}
93	},
94	"_id": "569f183514f4432160000007",
95	"role": "reader",
96	"email": "ariel@acme.com",
97	"firstName": "Ariel",
98	"lastName": "Flores"
99	}
100	],
101	"_links": {
102	"self": {
103	"href": "/api/v2/teams/example-team/maintainers?limit=5",
104	"type": "application/json"
105	}
106	}
107	}
108	}