Teams REST API

Although available, the API is not considered 'public' and could change in future releases

Teams

Get all teams

Get all teams

Returns a collection of all available teams

GET /rest/teamsforjira/1.0/teams

Response

 [
    {
        "actors": [
            {
                "avatarUrl": "http://www.gravatar.com/avatar/0be7a145b8d22e233a7bddf677288fd9?d=mm&s=16",
                "displayName": "Hannibal Smith",
                "id": "hannibal",
                "key": "hannibal",
                "type": "teams-user-actor"
            },
            {
                "avatarUrl": "http://www.gravatar.com/avatar/0be7a145b8d22e233a7bddf677288fd9?d=mm&s=16",
                "displayName": "Hannibal Smith",
                "id": "hannibal",
                "key": "hannibal",
                "type": "teams-lead-actor"
            },
            {
                "displayName": "jira-users",
                "id": "jira-users",
                "key": "jira-users",
                "type": "teams-group-actor"
            }
        ],
        "id": 1,
        "name": "The A Team"
    },
    {
        "actors": [],
        "id": 4,
        "name": "The B Team"
    }
]

Get team

Get team

Returns the Team with passed id if it exists.

GET   /rest/teamsforjira/1.0/team/{id}

Parameter	Type	Description
id	int	The id of the team to use

Response

{
    "actors": [
        {
            "avatarUrl": "http://www.gravatar.com/avatar/0be7a145b8d22e233a7bddf677288fd9?d=mm&s=16",
            "displayName": "Hannibal Smith",
            "id": "hannibal",
            "key": "hannibal",
            "type": "teams-user-actor"
        },
        {
            "avatarUrl": "http://www.gravatar.com/avatar/0be7a145b8d22e233a7bddf677288fd9?d=mm&s=16",
            "displayName": "Hannibal Smith",
            "id": "hannibal",
            "key": "hannibal",
            "type": "teams-lead-actor"
        },
        {
            "displayName": "jira-users",
            "id": "jira-users",
            "key": "jira-users",
            "type": "teams-group-actor"
        }
    ],
    "id": 1,
    "name": "The A Team"
}

Update team - add/remove members

Update the actors the Team with the passed data

PUT   /rest/teamsforjira/1.0/team/{id}

Request example

{
    "id": 1,
    "name": "The A Team",
    "categorisedActors": {
        "teams-group-actor": [
            "jira-users"
        ],
        "teams-lead-actor": [
            "hannibal"
        ],
        "teams-user-actor": [
            "hannibal"
        ]
    }
}

Create team

Create a team via POST.

POST   /rest/teamsforjira/1.0/team

Request example

{
    "name": "The A Team"
}

Response

{
    "actors": [],
    "id": 4,
    "name": "The A Team"
}

Delete teams

Delete team

Deletes a team

DELETE   /rest/teamsforjira/1.0/team/{id}

Teams for JIRA Service Desk

Teams REST API

Teams

Related content