Last updated May 24, 2024

Team field in Jira REST API

The Team field is a custom, single-select picker field that can be added to an issue in Jira using the type key com.atlassian.teams:rm-teams-custom-field-team. Before users can start using the Team field, make sure you enable it for both your site and project.

The Team field can be created, fetched, and updated in the same way as other custom fields via Jira REST API. See The Jira Cloud platform REST API.

Team ID

Team ID is the unique identifier of a Team used in JQL, Workflows, and REST API. Team IDs are typically long strings that look like this: 36885b3c-1bf0-4f85-a357-c5b858c31de4.

To find a specific team’s ID, go to the team’s profile page and copy the last segment in the URL that comes after /team/.

Creating or updating an issue with Team

The Team field can be added to the request body for creating and updating an issue by specifying a Team ID.

For example:

1
2
{
    "fields": {
       "customfield_10001" : "36885b3c-1bf0-4f85-a357-c5b858c31de4"
   }
}

In the above example:

Subtasks with Team

The Team cannot be changed in subtasks, and will instead use the same Team selected in the parent issue.

Getting an issue with Team

When getting an issue or when displayed in issue search results, the response for the Team field will look like the following example:

1
2
{
    "fields": {
        "customfield_10001": {
            "id": "36885b3c-1bf0-4f85-a357-c5b858c31de4",
            "name": "Some Team Name",
            "avatarUrl": "",
            "isVisible": true,
            "title": "Some Team Name",
            "isShared": true
        }
    }
}

Note that customfield_10001 is the identifier of the Team custom field and may be different in each Jira site.

Editmeta

If editmeta is included in the expand parameter of the request, then the response would include the JSON schema information of the Team field:

1
2
{
    "editmeta": {
        "fields": {
            "customfield_10001": {
                "required": false,
                "schema": {
                    "type": "any",
                    "custom": "com.atlassian.teams:rm-teams-custom-field-team",
                    "customId": 10001,
                    "configuration": {
                      "com.atlassian.jira.plugin.system.customfieldtypes:atlassian-team": true
                    }
                },
                "name": "Team",
                "key": "customfield_10001",
                "autoCompleteUrl": "https://your.jira.site/gateway/api/v1/recommendations",
                "operations": [
                    "set"
                ]
            }
        }
    }
}

Searching for issues by Team

When searching for issues, the Team field can be added to the JQL query to filter issues by Team. You will need to specify a Team ID to compare with.

Supported operators:

  • =
  • !=
  • IS
  • IS NOT
  • IN
  • NOT IN

Example JQL:

1
2
"Team[Team]" = 36885b3c-1bf0-4f85-a357-c5b858c31de4

To include the Team field in the search response, you will need to add its custom field ID, such as customfield_1001, in the fields parameter.

For the Team field in the search response, see the section above titled Getting an issue with Team.

Rate this page: