Last updatedJul 25, 2019

Entity properties

Entity properties allow apps to add key/value stores to Jira entities, such as issues or projects. These values can be indexed by Jira and queried via a REST API or through JQL. This page provides an overview and examples of how entity properties work.

Storing data against an entity with REST

The curl examples below show you how to store data against and retrieve data from an issue using REST. For information how to manipulate properties of other Jira entities, e.g. projects, please see the Jira REST API documentation.

Show me the code!

In order to modify, add or remove the properties, the user executing the request must have permission to edit the entity. For example, to add new property to issue ENPR-4, you need permission to edit the issue. To retrieve a property, the user must have read permissions for the issue.

Example 1: Storing data

The simple example below will store the JSON object {"content":"Test if works on Jira Cloud", "completed" : 1} against issue ENPR-4 with the key tasks.

curl -X PUT -H "Content-type: application/json"`ENPR-4`/properties/tasks -d '{"content":"Test if works on Jira Cloud", "completed" : 1}'

The key has a maximum length of 255 characters.

The value must be a valid JSON Object and has a maximum size of 32 KB.

Example 2: Retrieving data

The example below shows how to get all of the properties stored against an issue.

curl -X GET

The response from server will contain keys and URLs of all properties of the issue ENPR-4.


Example 3: Removing a property

The example below shows how to remove a property from an issue.

curl -X DELETE

Making searchable entity properties

Atlassian Connect can provide a module descriptor, making the issue properties searchable using JQL. For example, to index the data from the first example, apps provide the following module descriptors:

"jiraEntityProperties": [{
    "key": "jira-issue-tasklist-indexing",
    "name": {
        "value" :"Tasks index",
        "i18n": "tasks.index"
    "entityType": "issue",
    "keyConfigurations": [{
        "propertyKey" : "tasks",
        "extractions" : [{
            "objectName" : "content",
            "type" : "text"

The descriptor above will make Jira index the object "content" of the issue property "tasks" as a text. The available index data types are:

  • number: indexed as a number and allows for range ordering and searching on this field.
  • text: tokenized before indexing and allows for searching for particular words.
  • string: indexed as-is and allows for searching for the exact phrase only.
  • date: indexed as a date and allows for date range searching and ordering. The expected date format is [YYYY]-[MM]-[DD]. The expected date time format is [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss] with optional offset from UTC: +/-[hh]:[mm] or Z for no offset. For reference, please see ISO_8601 standard.

The indexed data is available for a JQL search. The JQL query...

2[tasks].completed = 1 AND[tasks].content ~ "works" 

...result is shown in this screenshot.

Alt text


See Entity Property reference