Manage team entities
This returns a list of all teams contained under an organization. This may be used as an option to export teams data within your organization.
string
Requiredstring
integer
string
Teams retrieved successfully. The details of the team are in the response.
Cursor pagination result for PublicApiTeam
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
{
"cursor": "<string>",
"entities": [
{
"description": "<string>",
"displayName": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"teamType": "OPEN"
}
]
}Creates a team, and adds the requesting user as the initial member.
string
RequiredDetails of the team to be created.
string
Requiredstring
Requiredstring
string
RequiredTeam created successfully. The details of the team are in the response, including the team ID, which can be used to reference the team for other operations.
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"displayName": "<string>",
"siteId": "<string>",
"teamType": "OPEN"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"description": "<string>",
"displayName": "<string>",
"members": [
{
"accountId": "<string>"
}
],
"organizationId": "<string>",
"teamId": "<string>",
"teamType": "OPEN",
"userPermissions": {
"ADD_MEMBERS": true,
"DELETE_TEAM": true,
"REMOVE_MEMBERS": true,
"UPDATE_TEAM": true
}
}string
Requiredstring
Requiredstring
Team retrieved successfully. The details of the team are in the response.
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams/{teamId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"description": "<string>",
"displayName": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"teamType": "OPEN",
"userPermissions": {
"ADD_MEMBERS": true,
"DELETE_TEAM": true,
"REMOVE_MEMBERS": true,
"UPDATE_TEAM": true
}
}string
Requiredstring
RequiredTeam deleted successfully.
1
2
curl --request DELETE \
--url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams/{teamId}'This will only update the fields that get passed in and leave the rest as unmodified.
string
Requiredstring
RequiredDetails the team is to be updated with.
string
string
Team updated successfully. The updated details of the team are in the response.
1
2
3
4
5
6
7
8
curl --request PATCH \
--url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams/{teamId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"description": "<string>",
"displayName": "<string>"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"description": "<string>",
"displayName": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"teamType": "OPEN",
"userPermissions": {
"ADD_MEMBERS": true,
"DELETE_TEAM": true,
"REMOVE_MEMBERS": true,
"UPDATE_TEAM": true
}
}string
Requiredstring
RequiredTeam restored successfully.
1
2
curl --request POST \
--url 'https://api.atlassian.com/public/teams/v1/org/{orgId}/teams/{teamId}/restore'This updates the cover photo of the team. The cover photo must be a valid image file.
string
RequiredThe cover photo to be uploaded.
string
RequiredTeam cover photo uploaded successfully.
1
2
curl --request PUT \
--url 'https://api.atlassian.com/public/teams/v1/{teamId}/cover-photo'Rate this page: