Teams Public API
    Teams Members Public API

    Rate this page:

    Teams Public API

    Manage team entities

    Create a team.

    POST /public/teams/v1/org/{orgId}/teams/

    Creates a team, and adds the requesting user as the initial member.

    Request

    Path parameters
    orgId Required

    string

    The ID of the organisation the team is to be created under.

    Body parameters
    displayName Required

    string

    Min length: 1, Max length: 80
    description Required

    string

    Min length: 0, Max length: 360
    teamType Required

    string

    Valid values: OPEN, MEMBER_INVITE

    siteId Required

    string

    Min length: 1, Max length: 255

    Example

    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>"
}'

    Responses

    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 typeValue
    application/json

    PublicApiTeamResponseWithMembers

    Get a single team.

    GET /public/teams/v1/org/{orgId}/teams/{teamId}

    Request

    Path parameters
    orgId Required

    string

    The ID of the organisation the team is to be retrieved from.

    teamId Required

    string

    The ID of the team to be retrieved.

    Example

    1
2
3
    curl --request GET \
  --url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/{teamId}' \
  --header 'Accept: application/json'

    Responses

    Team retrieved successfully. The details of the team are in the response.

    Content typeValue
    application/json

    PublicApiTeamResponse

    Delete a team.

    DELETE /public/teams/v1/org/{orgId}/teams/{teamId}

    Request

    Path parameters
    orgId Required

    string

    The ID of the organisation the team is to be deleted from.

    teamId Required

    string

    The ID of the team to be deleted.

    Example

    1
2
    curl --request DELETE \
  --url 'https://localhost:8080/public/teams/v1/org/{orgId}/teams/{teamId}'

    Responses

    Team deleted successfully.

    Modify a team.

    PATCH /public/teams/v1/org/{orgId}/teams/{teamId}

    This will only update the fields that get passed in and leave the rest as unmodified.

    Request

    Path parameters
    orgId Required

    string

    The ID of the organisation the team to be updated belongs to.

    teamId Required

    string

    The ID of the team to be updated.

    Body parameters
    displayName

    string

    Min length: 1, Max length: 80, Pattern: .*\S+.*
    description

    string

    Min length: 0, Max length: 360

    Example

    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>"
}'

    Responses

    Team updated successfully. The updated details of the team are in the response.

    Content typeValue
    application/json

    PublicApiTeamResponse

    Rate this page: