• Teams Public API
    • Teams Members Public API
    Platform
    Teams / / Schemas

    Teams Public API

    Postman Collection
    OpenAPI
    POST

    Create a team.

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

    Request

    Path parameters

    orgId

    string

    Required

    Request bodyapplication/json

    Details of the team to be created.

    description

    string

    Required
    displayName

    string

    Required
    siteId

    string

    teamType

    string

    Required

    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.

    application/json

    PublicApiTeamResponseWithMembers
    POST/gateway/api/public/teams/v1/org/{orgId}/teams/
    1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/org/{orgId}/teams/' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "description": "<string>", "displayName": "<string>", "siteId": "<string>", "teamType": "OPEN" }'
    201Response
    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 } }
    GET

    Get a single team.

    Request

    Path parameters

    orgId

    string

    Required
    teamId

    string

    Required

    Query parameters

    siteId

    string

    Responses

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

    application/json

    PublicApiTeamResponse
    GET/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}
    1 2 3 curl --request GET \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}' \ --header 'Accept: application/json'
    200Response
    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 } }
    DEL

    Delete a team.

    Request

    Path parameters

    orgId

    string

    Required
    teamId

    string

    Required

    Responses

    Team deleted successfully.

    DEL/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}
    1 2 curl --request DELETE \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}'
    PATCH

    Modify a team.

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

    Request

    Path parameters

    orgId

    string

    Required
    teamId

    string

    Required

    Request bodyapplication/json

    Details the team is to be updated with.

    description

    string

    displayName

    string

    Responses

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

    application/json

    PublicApiTeamResponse
    PATCH/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}
    1 2 3 4 5 6 7 8 curl --request PATCH \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/org/{orgId}/teams/{teamId}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "description": "<string>", "displayName": "<string>" }'
    200Response
    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 } }
    PUT

    Upload a team cover photo

    This updates the cover photo of the team. The cover photo must be a valid image file.

    Request

    Path parameters

    teamId

    string

    Required

    Request bodymultipart/form-data

    The cover photo to be uploaded.

    file

    string

    Required

    Responses

    Team cover photo uploaded successfully.

    PUT/gateway/api/public/teams/v1/{teamId}/cover-photo
    1 2 curl --request PUT \ --url 'https://sitename.atlassian.net/gateway/api/public/teams/v1/{teamId}/cover-photo'