Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page

Table of Contents

Use this method to retrieve the team of a specific project. The team consists of those users that have a role in that project, the same users that are displayed in the "Project Team" tab of that project dashboard.IMPORTANT:

Note

To retrieve the data using this method, you must be authenticated with a user that has permissions to edit the custom fields of other users. See Configuring the app permissions.

Request URL

The request URL takes the following form:

GET <ROOT>/rest/stonikbyte-project-team-api/1.0/project/{projectKey}/team?includeCustomFieldValues=true

Parameters

You have to specify the following parameters:

...

http:/ /MY_Jira_BASE_URL/rest/stonikbyte-project-team-api/1.0/project/DEMO/team
In this example the team of DEMO project is retrieved.

A successful response

An HTTP 200 status response indicates a successful request. The following data is returned in JSON format:

Code Block
languagejson
[
  {
    "key": "john.smith",
    "username": "john.smith",
    "email": "john.smith@stonikbyte.com",
    "displayName": "John Smith",
    "listProjectRoles": [
      {
        "id": 10101,
        "name": "Project Manager"
      },
      {
        "id": 10100,
        "name": "Programmer"
      }
    ]
  },
  {
    "key": "dorothy.grey",
    "username": "dorothy.grey",
    "email": "dorothy.grey@stonikbyte.com",
    "displayName": "Dorothy Grey",
    "listProjectRoles": [
      {
        "id": 10100,
        "name": "Programmer"
      }
    ]
  }
]

Error Response

If the REST call fails, the service returns one of the following HTTP statuses:

...