Rate this page:
Manage team entities
POST /public/teams/v1/org/{orgId}/teams/
Creates a team, and adds the requesting user as the initial member.
string
The ID of the organisation the team is to be created under.
string
1
, Max length: 80
string
0
, Max length: 360
string
Valid values: OPEN
, MEMBER_INVITE
string
1
, Max length: 255
1 2 3 4 5 6 7 8 9 10
curl --request POST \
--url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"description": "<string>",
"teamType": "OPEN",
"siteId": "<string>"
}'
Team 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.
Content type | Value |
---|---|
application/json |
GET /public/teams/v1/org/{orgId}/teams/{teamId}
string
The ID of the organisation the team is to be retrieved from.
string
The ID of the team to be retrieved.
1 2 3
curl --request GET \
--url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/{teamId}' \
--header 'Accept: application/json'
Team retrieved successfully. The details of the team are in the response.
Content type | Value |
---|---|
application/json |
DELETE /public/teams/v1/org/{orgId}/teams/{teamId}
string
The ID of the organisation the team is to be deleted from.
string
The ID of the team to be deleted.
1 2
curl --request DELETE \
--url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/{teamId}'
Team deleted successfully.
PATCH /public/teams/v1/org/{orgId}/teams/{teamId}
This will only update the fields that get passed in and leave the rest as unmodified.
string
The ID of the organisation the team to be updated belongs to.
string
The ID of the team to be updated.
string
1
, Max length: 80
, Pattern: .*\S+.*
string
0
, Max length: 360
1 2 3 4 5 6 7 8
curl --request PATCH \
--url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/{teamId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"description": "<string>"
}'
Team updated successfully. The updated details of the team are in the response.
Content type | Value |
---|---|
application/json |
Rate this page: