Go to appAcademyWhat's new?
Back
Artisan IMG > Jira Cloud (jira-cloud) (d63bf7a8-f971-4860-885c-04b648140115)
Jira Cloud
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Create issue
Copy

Create an issue in Jira.

Sample Input

1
{
2
    "project_key": "PROJ",
3
    "summary": "Implement new feature for user authentication",
4
    "issue_type_id": "10001",
5
    "labels": [
6
        "security",
7
        "authentication"
8
    ],
9
    "description": "We need to implement a new feature for user authentication that includes two-factor authentication and password complexity requirements.",
10
    "due_date": "2023-06-30",
11
    "assignee_key": "john.doe",
12
    "reporter_key": "jane.smith",
13
    "priority_id": "2",
14
    "versions": [
15
        "1.0",
16
        "1.1"
17
    ],
18
    "fix_versions": [
19
        "1.2"
20
    ],
21
    "other_fields": [
22
        {
23
            "name": "customfield_10001",
24
            "value": "High"
25
        },
26
        {
27
            "name": "customfield_10002",
28
            "value": [
29
                "Frontend",
30
                "Backend"
31
            ]
32
        }
33
    ]
34
}

Sample Output

1
{
2
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
3
    "id": "10234",
4
    "self": "https://your-domain.atlassian.net/rest/api/2/issue/10234",
5
    "key": "PROJ-123",
6
    "fields": {
7
        "issuetype": {
8
            "self": "https://your-domain.atlassian.net/rest/api/2/issuetype/10001",
9
            "id": "10001",
10
            "description": "A task that needs to be done.",
11
            "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype",
12
            "name": "Task",
13
            "subtask": false,
14
            "avatarId": 10318
15
        },
16
        "project": {
17
            "self": "https://your-domain.atlassian.net/rest/api/2/project/10000",
18
            "id": "10000",
19
            "key": "PROJ",
20
            "name": "Sample Project",
21
            "avatarUrls": {
22
                "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
23
                "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
24
                "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
25
                "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
26
            }
27
        },
28
        "priority": {
29
            "self": "https://your-domain.atlassian.net/rest/api/2/priority/2",
30
            "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/high.svg",
31
            "name": "High",
32
            "id": "2"
33
        },
34
        "labels": [
35
            "security",
36
            "authentication"
37
        ],
38
        "versions": [
39
            {
40
                "self": "https://your-domain.atlassian.net/rest/api/2/version/10000",
41
                "id": "10000",
42
                "name": "1.0",
43
                "archived": false,
44
                "released": true
45
            },
46
            {
47
                "self": "https://your-domain.atlassian.net/rest/api/2/version/10001",
48
                "id": "10001",
49
                "name": "1.1",
50
                "archived": false,
51
                "released": false
52
            }
53
        ],
54
        "fixVersions": [
55
            {
56
                "self": "https://your-domain.atlassian.net/rest/api/2/version/10002",
57
                "id": "10002",
58
                "name": "1.2",
59
                "archived": false,
60
                "released": false
61
            }
62
        ],
63
        "assignee": {
64
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g",
65
            "name": "john.doe",
66
            "key": "john.doe",
67
            "emailAddress": "john.doe@example.com",
68
            "avatarUrls": {
69
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/48",
70
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/24",
71
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/16",
72
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/32"
73
            },
74
            "displayName": "John Doe",
75
            "active": true,
76
            "timeZone": "Australia/Sydney"
77
        },
78
        "status": {
79
            "self": "https://your-domain.atlassian.net/rest/api/2/status/10000",
80
            "description": "The issue is open and ready for the assignee to start work on it.",
81
            "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
82
            "name": "To Do",
83
            "id": "10000",
84
            "statusCategory": {
85
                "self": "https://your-domain.atlassian.net/rest/api/2/statuscategory/2",
86
                "id": 2,
87
                "key": "new",
88
                "colorName": "blue-gray",
89
                "name": "To Do"
90
            }
91
        },
92
        "description": "We need to implement a new feature for user authentication that includes two-factor authentication and password complexity requirements.",
93
        "summary": "Implement new feature for user authentication",
94
        "creator": {
95
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21h",
96
            "name": "jane.smith",
97
            "key": "jane.smith",
98
            "emailAddress": "jane.smith@example.com",
99
            "avatarUrls": {
100
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/48",
101
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/24",
102
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/16",
103
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/32"
104
            },
105
            "displayName": "Jane Smith",
106
            "active": true,
107
            "timeZone": "Australia/Sydney"
108
        },
109
        "reporter": {
110
            "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21h",
111
            "name": "jane.smith",
112
            "key": "jane.smith",
113
            "emailAddress": "jane.smith@example.com",
114
            "avatarUrls": {
115
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/48",
116
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/24",
117
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/16",
118
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/32"
119
            },
120
            "displayName": "Jane Smith",
121
            "active": true,
122
            "timeZone": "Australia/Sydney"
123
        },
124
        "duedate": "2023-06-30",
125
        "customfield_10001": "High",
126
        "customfield_10002": [
127
            "Frontend",
128
            "Backend"
129
        ]
130
    }
131
}

Create issue attachment
Copy

Creates an attachment on an issue.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "attachment": {
4
        "filename": "bug_report.pdf",
5
        "content": "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29kZSA+PgpzdHJlYW0KeAGNksFugzAMhu99Cp9gD8ZJCGlwQtoOe4CpF9oOEweEtNJWgulh...",
6
        "mime_type": "application/pdf"
7
    }
8
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "self": "https://your-domain.atlassian.net/rest/api/3/attachment/10000",
5
            "id": "10000",
6
            "filename": "bug_report.pdf",
7
            "author": {
8
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
9
                "name": "john.doe",
10
                "key": "john.doe",
11
                "accountId": "5b10a2844c20165700ede21g",
12
                "emailAddress": "john.doe@example.com",
13
                "avatarUrls": {
14
                    "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48",
15
                    "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
16
                    "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
17
                    "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32"
18
                },
19
                "displayName": "John Doe",
20
                "active": true,
21
                "timeZone": "Australia/Sydney",
22
                "accountType": "atlassian"
23
            },
24
            "created": "2023-06-15T09:30:00.000+0000",
25
            "size": 58392,
26
            "mimeType": "application/pdf",
27
            "content": "https://your-domain.atlassian.net/secure/attachment/10000/bug_report.pdf"
28
        }
29
    ]
30
}

Create issue comment
Copy

Creates a comment on an issue.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "body": "This is a new comment on the issue. We should consider adding more details to the reproduction steps.",
4
    "properties": [
5
        {
6
            "key": "comment_type",
7
            "value": {
8
                "type": "internal"
9
            }
10
        }
11
    ]
12
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/456789",
3
    "id": "456789",
4
    "author": {
5
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
6
        "name": "john.doe",
7
        "key": "john.doe",
8
        "accountId": "5b10a2844c20165700ede21g",
9
        "emailAddress": "john.doe@example.com",
10
        "avatarUrls": {
11
            "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
12
            "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
13
            "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
14
            "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
15
        },
16
        "displayName": "John Doe",
17
        "active": true,
18
        "timeZone": "America/New_York",
19
        "accountType": "atlassian"
20
    },
21
    "body": "This is a new comment on the issue. We should consider adding more details to the reproduction steps.",
22
    "updateAuthor": {
23
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
24
        "name": "john.doe",
25
        "key": "john.doe",
26
        "accountId": "5b10a2844c20165700ede21g",
27
        "emailAddress": "john.doe@example.com",
28
        "avatarUrls": {
29
            "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
30
            "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
31
            "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
32
            "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
33
        },
34
        "displayName": "John Doe",
35
        "active": true,
36
        "timeZone": "America/New_York",
37
        "accountType": "atlassian"
38
    },
39
    "created": "2023-06-15T14:30:00.000+0000",
40
    "updated": "2023-06-15T14:30:00.000+0000",
41
    "jsdPublic": false
42
}

Create a link between two Jira issues.

Sample Input

1
{
2
    "link_type": "Relates",
3
    "inward_issue": "PROJ-123",
4
    "outward_issue": "PROJ-456"
5
}

Sample Output

1
{
2
    "success": true
3
}

Create version
Copy

Create a project version to be released.

Sample Input

1
{
2
    "name": "Version 2.0",
3
    "description": "Major release with new features and bug fixes",
4
    "project": "PROJ",
5
    "user_start_date": "2023-06-01T00:00:00Z",
6
    "user_release_date": "2023-09-30T23:59:59Z",
7
    "archived": false,
8
    "released": false
9
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
3
    "id": "10000",
4
    "description": "Major release with new features and bug fixes",
5
    "name": "Version 2.0",
6
    "archived": false,
7
    "released": false,
8
    "startDate": "2023-06-01",
9
    "releaseDate": "2023-09-30",
10
    "overdue": false,
11
    "userStartDate": "2023-06-01T00:00:00.000Z",
12
    "userReleaseDate": "2023-09-30T23:59:59.000Z",
13
    "projectId": 10001
14
}

Delete issue
Copy

Delete an issue from your Jira account. Optionally also delete the attached subtasks.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "delete_subtasks": true
4
}

Sample Output

1
{
2
    "deleted": true
3
}

Download issue attachment
Copy

Download an attachment by providing its ID.

Sample Input

1
{
2
    "attachment_id": "10001"
3
}

Sample Output

1
{
2
    "name": "project_requirements.pdf",
3
    "url": "https://jira-instance.atlassian.net/secure/attachment/10001/project_requirements.pdf",
4
    "mime_type": "application/pdf",
5
    "expires": 1623456789000
6
}

Get attachment metadata
Copy

Returns the metadata for an attachment. Note that the attachment itself is not returned.

Sample Input

1
{
2
    "attachment_id": "10001"
3
}

Sample Output

1
{
2
    "id": 10001,
3
    "self": "https://your-domain.atlassian.net/rest/api/3/attachment/10001",
4
    "filename": "example_document.pdf",
5
    "author": {
6
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
7
        "accountId": "5b10a2844c20165700ede21g",
8
        "avatarUrls": {
9
            "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
10
            "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
11
            "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
12
            "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
13
        },
14
        "displayName": "Mark Kennedy",
15
        "active": true
16
    },
17
    "created": "2023-05-15T09:30:00.000+0000",
18
    "size": 2048000,
19
    "mimeType": "application/pdf",
20
    "properties": {},
21
    "content": "https://your-domain.atlassian.net/rest/api/3/attachment/content/10001",
22
    "thumbnail": "https://your-domain.atlassian.net/rest/api/3/attachment/thumbnail/10001"
23
}

Get comment property
Copy

Returns the value of a comment property.

Sample Input

1
{
2
    "comment_id": "10001",
3
    "property_key": "custom_field_123"
4
}

Sample Output

1
{
2
    "keys": [
3
        {
4
            "self": "https://your-domain.atlassian.net/rest/api/3/comment/10001/properties/custom_field_123",
5
            "key": "custom_field_123"
6
        }
7
    ]
8
}

Get issue
Copy

Get details of an issue, using the issue's unique ID or Key.

Sample Input

1
{
2
    "issue_id": "CTP-123"
3
}

Sample Output

1
{
2
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
3
    "id": "10001",
4
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
5
    "key": "CTP-123",
6
    "fields": {
7
        "issuetype": {
8
            "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10001",
9
            "id": "10001",
10
            "description": "A task that needs to be done.",
11
            "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype",
12
            "name": "Task",
13
            "subtask": false,
14
            "avatarId": 10318
15
        },
16
        "timespent": null,
17
        "project": {
18
            "self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
19
            "id": "10000",
20
            "key": "CTP",
21
            "name": "Customer Tracking Project",
22
            "avatarUrls": {
23
                "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
24
                "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
25
                "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
26
                "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
27
            }
28
        },
29
        "fixVersions": [],
30
        "aggregatetimespent": null,
31
        "resolution": null,
32
        "resolutiondate": null,
33
        "workratio": -1,
34
        "lastViewed": "2023-05-17T09:30:00.000+0000",
35
        "watches": {
36
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/watchers",
37
            "watchCount": 1,
38
            "isWatching": true
39
        },
40
        "created": "2023-05-15T14:00:00.000+0000",
41
        "priority": {
42
            "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
43
            "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/medium.svg",
44
            "name": "Medium",
45
            "id": "3"
46
        },
47
        "labels": [
48
            "customer-facing",
49
            "urgent"
50
        ],
51
        "timeestimate": null,
52
        "aggregatetimeoriginalestimate": null,
53
        "versions": [],
54
        "issuelinks": [],
55
        "assignee": {
56
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
57
            "name": "john.doe",
58
            "key": "john.doe",
59
            "emailAddress": "john.doe@example.com",
60
            "avatarUrls": {
61
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/a447bfe0-eca1-4317-9941-5361ef3dff9f/48",
62
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/a447bfe0-eca1-4317-9941-5361ef3dff9f/24",
63
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/a447bfe0-eca1-4317-9941-5361ef3dff9f/16",
64
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/a447bfe0-eca1-4317-9941-5361ef3dff9f/32"
65
            },
66
            "displayName": "John Doe",
67
            "active": true,
68
            "timeZone": "America/New_York"
69
        },
70
        "updated": "2023-05-17T10:00:00.000+0000",
71
        "status": {
72
            "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
73
            "description": "The issue is open and ready for the assignee to start work on it.",
74
            "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
75
            "name": "To Do",
76
            "id": "10000",
77
            "statusCategory": {
78
                "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
79
                "id": 2,
80
                "key": "new",
81
                "colorName": "blue-gray",
82
                "name": "To Do"
83
            }
84
        },
85
        "components": [],
86
        "timeoriginalestimate": null,
87
        "description": "We need to update the customer portal with the latest features and bug fixes.",
88
        "timetracking": {},
89
        "attachment": [],
90
        "aggregatetimeestimate": null,
91
        "summary": "Update customer portal",
92
        "creator": {
93
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21f",
94
            "name": "jane.smith",
95
            "key": "jane.smith",
96
            "emailAddress": "jane.smith@example.com",
97
            "avatarUrls": {
98
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/48",
99
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/24",
100
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/16",
101
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/32"
102
            },
103
            "displayName": "Jane Smith",
104
            "active": true,
105
            "timeZone": "America/New_York"
106
        },
107
        "subtasks": [],
108
        "reporter": {
109
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21f",
110
            "name": "jane.smith",
111
            "key": "jane.smith",
112
            "emailAddress": "jane.smith@example.com",
113
            "avatarUrls": {
114
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/48",
115
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/24",
116
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/16",
117
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/32"
118
            },
119
            "displayName": "Jane Smith",
120
            "active": true,
121
            "timeZone": "America/New_York"
122
        },
123
        "aggregateprogress": {
124
            "progress": 0,
125
            "total": 0
126
        },
127
        "environment": null,
128
        "duedate": "2023-05-31",
129
        "progress": {
130
            "progress": 0,
131
            "total": 0
132
        },
133
        "comment": {
134
            "comments": [],
135
            "maxResults": 0,
136
            "total": 0,
137
            "startAt": 0
138
        },
139
        "votes": {
140
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/votes",
141
            "votes": 0,
142
            "hasVoted": false
143
        },
144
        "worklog": {
145
            "startAt": 0,
146
            "maxResults": 20,
147
            "total": 0,
148
            "worklogs": []
149
        }
150
    }
151
}

Get user
Copy

Get a user from Jira, either by their username or their user "key".

Sample Input

1
{
2
    "account_id": "5b10a2844c20165700ede21g",
3
    "expand": "groups,applicationRoles"
4
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
3
    "accountId": "5b10a2844c20165700ede21g",
4
    "accountType": "atlassian",
5
    "emailAddress": "john.doe@example.com",
6
    "avatarUrls": {
7
        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-9cbf-4d3b98d3e8a1/48",
8
        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-9cbf-4d3b98d3e8a1/24",
9
        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-9cbf-4d3b98d3e8a1/16",
10
        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-9cbf-4d3b98d3e8a1/32"
11
    },
12
    "displayName": "John Doe",
13
    "active": true,
14
    "timeZone": "America/New_York",
15
    "locale": "en_US",
16
    "groups": {
17
        "size": 2,
18
        "items": [
19
            {
20
                "name": "jira-software-users",
21
                "self": "https://your-domain.atlassian.net/rest/api/3/group?groupname=jira-software-users"
22
            },
23
            {
24
                "name": "jira-core-users",
25
                "self": "https://your-domain.atlassian.net/rest/api/3/group?groupname=jira-core-users"
26
            }
27
        ]
28
    },
29
    "applicationRoles": {
30
        "size": 2,
31
        "items": [
32
            {
33
                "key": "jira-software",
34
                "name": "Jira Software"
35
            },
36
            {
37
                "key": "jira-core",
38
                "name": "Jira Core"
39
            }
40
        ]
41
    },
42
    "expand": "groups,applicationRoles"
43
}

Get user info
Copy

Get information about the current authenticated user.

Sample Input

1
{}

Sample Output

1
{
2
    "instance_url": "https://your-domain.atlassian.net"
3
}

Get version
Copy

Get a project version by its ID.

Sample Input

1
{
2
    "id": "10000"
3
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
3
    "id": "10000",
4
    "description": "Version 1.0 of our project",
5
    "name": "Version 1.0",
6
    "archived": false,
7
    "released": true,
8
    "startDate": "2023-01-15",
9
    "releaseDate": "2023-06-30",
10
    "overdue": false,
11
    "userStartDate": "15/Jan/23",
12
    "userReleaseDate": "30/Jun/23",
13
    "projectId": 1001
14
}

List issue comments
Copy

Lists all of the comments for an issue.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "start_at": 0,
4
    "max_results": 50,
5
    "expand": "renderedBody,properties"
6
}

Sample Output

1
{
2
    "startAt": 0,
3
    "maxResults": 50,
4
    "total": 2,
5
    "comments": [
6
        {
7
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/10000",
8
            "id": "10000",
9
            "author": {
10
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
11
                "name": "john.doe",
12
                "key": "john.doe",
13
                "accountId": "5b10a2844c20165700ede21g",
14
                "emailAddress": "john.doe@example.com",
15
                "avatarUrls": {
16
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/48",
17
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/24",
18
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/16",
19
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/32"
20
                },
21
                "displayName": "John Doe",
22
                "active": true,
23
                "timeZone": "Australia/Sydney",
24
                "accountType": "atlassian"
25
            },
26
            "body": "This is the first comment on the issue.",
27
            "updateAuthor": {
28
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
29
                "name": "john.doe",
30
                "key": "john.doe",
31
                "accountId": "5b10a2844c20165700ede21g",
32
                "emailAddress": "john.doe@example.com",
33
                "avatarUrls": {
34
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/48",
35
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/24",
36
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/16",
37
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/32"
38
                },
39
                "displayName": "John Doe",
40
                "active": true,
41
                "timeZone": "Australia/Sydney",
42
                "accountType": "atlassian"
43
            },
44
            "created": "2023-05-18T09:30:00.000+0000",
45
            "updated": "2023-05-18T09:30:00.000+0000",
46
            "jsdPublic": true,
47
            "properties": [
48
                {
49
                    "key": "custom-property",
50
                    "value": {
51
                        "value1": "Some custom value"
52
                    }
53
                }
54
            ]
55
        },
56
        {
57
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/10001",
58
            "id": "10001",
59
            "author": {
60
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
61
                "name": "jane.smith",
62
                "key": "jane.smith",
63
                "accountId": "5b10a2844c20165700ede21h",
64
                "emailAddress": "jane.smith@example.com",
65
                "avatarUrls": {
66
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/48",
67
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/24",
68
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/16",
69
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/32"
70
                },
71
                "displayName": "Jane Smith",
72
                "active": true,
73
                "timeZone": "America/New_York",
74
                "accountType": "atlassian"
75
            },
76
            "body": "This is the second comment on the issue.",
77
            "updateAuthor": {
78
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
79
                "name": "jane.smith",
80
                "key": "jane.smith",
81
                "accountId": "5b10a2844c20165700ede21h",
82
                "emailAddress": "jane.smith@example.com",
83
                "avatarUrls": {
84
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/48",
85
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/24",
86
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/16",
87
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/32"
88
                },
89
                "displayName": "Jane Smith",
90
                "active": true,
91
                "timeZone": "America/New_York",
92
                "accountType": "atlassian"
93
            },
94
            "created": "2023-05-18T10:15:00.000+0000",
95
            "updated": "2023-05-18T10:15:00.000+0000",
96
            "jsdPublic": true,
97
            "properties": []
98
        }
99
    ]
100
}

List issue worklogs
Copy

Returns all worklogs for an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error.

Sample Input

1
{
2
    "issue_id": "CTP-123"
3
}

Sample Output

1
{
2
    "startAt": 0,
3
    "maxResults": 50,
4
    "total": 2,
5
    "worklogs": [
6
        {
7
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/worklog/12345",
8
            "author": {
9
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
10
                "name": "john.doe",
11
                "key": "john.doe",
12
                "accountId": "5b10a2844c20165700ede21g",
13
                "emailAddress": "john.doe@example.com",
14
                "avatarUrls": {
15
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
16
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
17
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
18
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
19
                },
20
                "displayName": "John Doe",
21
                "active": true,
22
                "timeZone": "Australia/Sydney"
23
            },
24
            "updateAuthor": {
25
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
26
                "name": "john.doe",
27
                "key": "john.doe",
28
                "accountId": "5b10a2844c20165700ede21g",
29
                "emailAddress": "john.doe@example.com",
30
                "avatarUrls": {
31
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
32
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
33
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
34
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
35
                },
36
                "displayName": "John Doe",
37
                "active": true,
38
                "timeZone": "Australia/Sydney"
39
            },
40
            "comment": "Worked on implementing new feature",
41
            "created": "2023-05-15T09:00:00.000+0000",
42
            "updated": "2023-05-15T09:00:00.000+0000",
43
            "started": "2023-05-15T09:00:00.000+0000",
44
            "timeSpent": "3h 30m",
45
            "timeSpentSeconds": 12600,
46
            "id": "12345",
47
            "issueId": "CTP-123"
48
        },
49
        {
50
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/worklog/12346",
51
            "author": {
52
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
53
                "name": "jane.smith",
54
                "key": "jane.smith",
55
                "accountId": "5b10a2844c20165700ede21h",
56
                "emailAddress": "jane.smith@example.com",
57
                "avatarUrls": {
58
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=48&s=48",
59
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=24&s=24",
60
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=16&s=16",
61
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=32&s=32"
62
                },
63
                "displayName": "Jane Smith",
64
                "active": true,
65
                "timeZone": "America/New_York"
66
            },
67
            "updateAuthor": {
68
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
69
                "name": "jane.smith",
70
                "key": "jane.smith",
71
                "accountId": "5b10a2844c20165700ede21h",
72
                "emailAddress": "jane.smith@example.com",
73
                "avatarUrls": {
74
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=48&s=48",
75
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=24&s=24",
76
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=16&s=16",
77
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=32&s=32"
78
                },
79
                "displayName": "Jane Smith",
80
                "active": true,
81
                "timeZone": "America/New_York"
82
            },
83
            "comment": "Reviewed and tested the new feature",
84
            "created": "2023-05-15T14:30:00.000+0000",
85
            "updated": "2023-05-15T14:30:00.000+0000",
86
            "started": "2023-05-15T14:30:00.000+0000",
87
            "timeSpent": "1h 45m",
88
            "timeSpentSeconds": 6300,
89
            "id": "12346",
90
            "issueId": "CTP-123"
91
        }
92
    ]
93
}

List project issues
Copy

Get a list of all of the issues in a project.

Sample Input

1
{
2
    "project_id": "PROJ",
3
    "updated_after": "2023-05-01",
4
    "per_page": 50,
5
    "page": 1
6
}

Sample Output

1
{
2
    "expand": "schema,names",
3
    "startAt": 0,
4
    "maxResults": 50,
5
    "total": 2,
6
    "issues": [
7
        {
8
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
9
            "id": "10001",
10
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
11
            "key": "PROJ-1",
12
            "fields": {
13
                "issuetype": {
14
                    "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10001",
15
                    "id": "10001",
16
                    "description": "A task that needs to be done.",
17
                    "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype",
18
                    "name": "Task",
19
                    "subtask": false,
20
                    "avatarId": 10318
21
                },
22
                "timespent": null,
23
                "project": {
24
                    "self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
25
                    "id": "10000",
26
                    "key": "PROJ",
27
                    "name": "Sample Project",
28
                    "avatarUrls": {
29
                        "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
30
                        "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
31
                        "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
32
                        "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
33
                    }
34
                },
35
                "fixVersions": [],
36
                "aggregatetimespent": null,
37
                "resolution": null,
38
                "resolutiondate": null,
39
                "workratio": -1,
40
                "lastViewed": "2023-05-15T10:00:00.000+0000",
41
                "watches": {
42
                    "self": "https://your-domain.atlassian.net/rest/api/3/issue/PROJ-1/watchers",
43
                    "watchCount": 1,
44
                    "isWatching": true
45
                },
46
                "created": "2023-05-10T09:00:00.000+0000",
47
                "priority": {
48
                    "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
49
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/medium.svg",
50
                    "name": "Medium",
51
                    "id": "3"
52
                },
53
                "labels": [
54
                    "documentation"
55
                ],
56
                "timeestimate": null,
57
                "aggregatetimeoriginalestimate": null,
58
                "versions": [],
59
                "issuelinks": [],
60
                "assignee": {
61
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
62
                    "name": "john.doe",
63
                    "key": "john.doe",
64
                    "emailAddress": "john.doe@example.com",
65
                    "avatarUrls": {
66
                        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/48",
67
                        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/24",
68
                        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/16",
69
                        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/32"
70
                    },
71
                    "displayName": "John Doe",
72
                    "active": true,
73
                    "timeZone": "Australia/Sydney"
74
                },
75
                "updated": "2023-05-15T11:00:00.000+0000",
76
                "status": {
77
                    "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
78
                    "description": "The issue is open and ready for the assignee to start work on it.",
79
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
80
                    "name": "To Do",
81
                    "id": "10000",
82
                    "statusCategory": {
83
                        "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
84
                        "id": 2,
85
                        "key": "new",
86
                        "colorName": "blue-gray",
87
                        "name": "To Do"
88
                    }
89
                },
90
                "components": [],
91
                "timeoriginalestimate": null,
92
                "description": "We need to update the API documentation for the new features.",
93
                "aggregatetimeestimate": null,
94
                "summary": "Update API documentation",
95
                "creator": {
96
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
97
                    "name": "john.doe",
98
                    "key": "john.doe",
99
                    "emailAddress": "john.doe@example.com",
100
                    "avatarUrls": {
101
                        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/48",
102
                        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/24",
103
                        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/16",
104
                        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/32"
105
                    },
106
                    "displayName": "John Doe",
107
                    "active": true,
108
                    "timeZone": "Australia/Sydney"
109
                },
110
                "subtasks": [],
111
                "reporter": {
112
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
113
                    "name": "john.doe",
114
                    "key": "john.doe",
115
                    "emailAddress": "john.doe@example.com",
116
                    "avatarUrls": {
117
                        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/48",
118
                        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/24",
119
                        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/16",
120
                        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/32"
121
                    },
122
                    "displayName": "John Doe",
123
                    "active": true,
124
                    "timeZone": "Australia/Sydney"
125
                },
126
                "aggregateprogress": {
127
                    "progress": 0,
128
                    "total": 0
129
                },
130
                "environment": null,
131
                "duedate": "2023-05-31",
132
                "progress": {
133
                    "progress": 0,
134
                    "total": 0
135
                },
136
                "votes": {
137
                    "self": "https://your-domain.atlassian.net/rest/api/3/issue/PROJ-1/votes",
138
                    "votes": 0,
139
                    "hasVoted": false
140
                }
141
            }
142
        }
143
    ]
144
}

List projects
Copy

Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.

Sample Input

1
{}

Sample Output

1
{
2
    "items": [
3
        {
4
            "expand": "description,lead,issueTypes,url,projectKeys",
5
            "self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
6
            "id": "10000",
7
            "key": "PRJ",
8
            "description": "This is a sample project description",
9
            "lead": {
10
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
11
                "key": "john.doe",
12
                "name": "John Doe",
13
                "avatarUrls": {
14
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
15
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
16
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32",
17
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48"
18
                },
19
                "displayName": "John Doe",
20
                "active": true
21
            },
22
            "issueTypes": [
23
                {
24
                    "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10001",
25
                    "id": "10001",
26
                    "description": "A task that needs to be done.",
27
                    "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype",
28
                    "name": "Task",
29
                    "subtask": false,
30
                    "avatarId": 10318
31
                }
32
            ],
33
            "name": "Sample Project",
34
            "avatarUrls": {
35
                "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
36
                "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
37
                "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
38
                "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
39
            },
40
            "projectKeys": [
41
                "PRJ"
42
            ],
43
            "projectTypeKey": "software"
44
        }
45
    ]
46
}

List sprint issues
Copy

Lists all the issues in a specific sprint.

Sample Input

1
{
2
    "board_id": "123",
3
    "sprint_id": "456",
4
    "jql": "project = PROJ AND status = 'In Progress'",
5
    "fields": [
6
        "summary",
7
        "status",
8
        "assignee"
9
    ],
10
    "expand": "changelog",
11
    "start_at": 0,
12
    "max_results": 50
13
}

Sample Output

1
{
2
    "expand": "schema,names",
3
    "startAt": 0,
4
    "maxResults": 50,
5
    "total": 2,
6
    "issues": [
7
        {
8
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
9
            "id": "10001",
10
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
11
            "key": "PROJ-1",
12
            "fields": {
13
                "summary": "Implement new feature",
14
                "status": {
15
                    "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
16
                    "description": "This issue is being actively worked on at the moment by the assignee.",
17
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
18
                    "name": "In Progress",
19
                    "id": "3",
20
                    "statusCategory": {
21
                        "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
22
                        "id": 2,
23
                        "key": "inprogress",
24
                        "colorName": "yellow",
25
                        "name": "In Progress"
26
                    }
27
                },
28
                "assignee": {
29
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
30
                    "name": "john.doe",
31
                    "key": "john.doe",
32
                    "accountId": "5b10a2844c20165700ede21g",
33
                    "emailAddress": "john.doe@example.com",
34
                    "avatarUrls": {
35
                        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48",
36
                        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
37
                        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
38
                        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32"
39
                    },
40
                    "displayName": "John Doe",
41
                    "active": true,
42
                    "timeZone": "Australia/Sydney"
43
                }
44
            }
45
        },
46
        {
47
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
48
            "id": "10002",
49
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002",
50
            "key": "PROJ-2",
51
            "fields": {
52
                "summary": "Fix critical bug",
53
                "status": {
54
                    "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
55
                    "description": "This issue is being actively worked on at the moment by the assignee.",
56
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
57
                    "name": "In Progress",
58
                    "id": "3",
59
                    "statusCategory": {
60
                        "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
61
                        "id": 2,
62
                        "key": "inprogress",
63
                        "colorName": "yellow",
64
                        "name": "In Progress"
65
                    }
66
                },
67
                "assignee": {
68
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
69
                    "name": "jane.smith",
70
                    "key": "jane.smith",
71
                    "accountId": "5b10a2844c20165700ede21h",
72
                    "emailAddress": "jane.smith@example.com",
73
                    "avatarUrls": {
74
                        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=48&s=48",
75
                        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=24&s=24",
76
                        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=16&s=16",
77
                        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=32&s=32"
78
                    },
79
                    "displayName": "Jane Smith",
80
                    "active": true,
81
                    "timeZone": "America/New_York"
82
                }
83
            }
84
        }
85
    ]
86
}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1
{
2
    "method": "POST",
3
    "url": {
4
        "endpoint": "/rest/api/3/issue"
5
    },
6
    "headers": [
7
        {
8
            "key": "Content-Type",
9
            "value": "application/json"
10
        }
11
    ],
12
    "body": {
13
        "raw": {
14
            "fields": {
15
                "project": {
16
                    "key": "PROJ"
17
                },
18
                "summary": "New issue created via API",
19
                "issuetype": {
20
                    "name": "Task"
21
                },
22
                "description": {
23
                    "type": "doc",
24
                    "version": 1,
25
                    "content": [
26
                        {
27
                            "type": "paragraph",
28
                            "content": [
29
                                {
30
                                    "text": "This is a sample issue created using the Jira Cloud API.",
31
                                    "type": "text"
32
                                }
33
                            ]
34
                        }
35
                    ]
36
                }
37
            }
38
        }
39
    },
40
    "include_raw_body": false,
41
    "parse_response": "true"
42
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 201,
4
        "headers": {
5
            "Content-Type": "application/json;charset=UTF-8",
6
            "X-AUSERNAME": "admin",
7
            "X-Seraph-LoginReason": "OK"
8
        },
9
        "body": {
10
            "id": "10001",
11
            "key": "PROJ-1",
12
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
13
        }
14
    }
15
}

Search issues (JQL)
Copy

Search for issues using JQL.

Sample Input

1
{
2
    "jql": "project = 'PROJ' AND status = 'Open' ORDER BY priority DESC",
3
    "expand": "description,lead,projectKeys,url,issueTypes",
4
    "per_page": 50,
5
    "start_at": 0
6
}

Sample Output

1
{
2
    "expand": "schema,names",
3
    "startAt": 0,
4
    "maxResults": 50,
5
    "total": 2,
6
    "issues": [
7
        {
8
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
9
            "id": "10001",
10
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
11
            "key": "PROJ-1",
12
            "fields": {
13
                "watcher": {
14
                    "self": "https://your-domain.atlassian.net/rest/api/3/issue/PROJ-1/watchers",
15
                    "isWatching": true,
16
                    "watchCount": 1,
17
                    "watchers": [
18
                        {
19
                            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
20
                            "accountId": "5b10a2844c20165700ede21g",
21
                            "displayName": "John Doe",
22
                            "active": true
23
                        }
24
                    ]
25
                },
26
                "attachment": [
27
                    {
28
                        "id": 10000,
29
                        "self": "https://your-domain.atlassian.net/rest/api/3/attachment/10000",
30
                        "filename": "picture.jpg",
31
                        "author": {
32
                            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
33
                            "key": "johnd",
34
                            "accountId": "5b10a2844c20165700ede21g",
35
                            "name": "John Doe",
36
                            "avatarUrls": {
37
                                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48",
38
                                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
39
                                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
40
                                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32"
41
                            },
42
                            "displayName": "John Doe",
43
                            "active": true
44
                        },
45
                        "created": "2023-05-05T10:00:00.000+0000",
46
                        "size": 23423,
47
                        "mimeType": "image/jpeg",
48
                        "content": "https://your-domain.atlassian.net/rest/api/3/attachment/content/10000"
49
                    }
50
                ],
51
                "sub-tasks": [],
52
                "description": "This is a sample issue description.",
53
                "project": {
54
                    "self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
55
                    "id": "10000",
56
                    "key": "PROJ",
57
                    "name": "Sample Project",
58
                    "avatarUrls": {
59
                        "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000",
60
                        "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
61
                        "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
62
                        "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000"
63
                    },
64
                    "projectCategory": {
65
                        "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000",
66
                        "id": "10000",
67
                        "name": "Software",
68
                        "description": "Software projects"
69
                    },
70
                    "simplified": false,
71
                    "style": "classic",
72
                    "insight": {
73
                        "totalIssueCount": 100,
74
                        "lastIssueUpdateTime": "2023-05-05T10:00:00.000+0000"
75
                    }
76
                },
77
                "comment": [
78
                    {
79
                        "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001/comment/10000",
80
                        "id": "10000",
81
                        "author": {
82
                            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
83
                            "accountId": "5b10a2844c20165700ede21g",
84
                            "displayName": "John Doe",
85
                            "active": true
86
                        },
87
                        "body": "This is a sample comment.",
88
                        "updateAuthor": {
89
                            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
90
                            "accountId": "5b10a2844c20165700ede21g",
91
                            "displayName": "John Doe",
92
                            "active": true
93
                        },
94
                        "created": "2023-05-05T10:00:00.000+0000",
95
                        "updated": "2023-05-05T10:00:00.000+0000",
96
                        "visibility": {
97
                            "type": "role",
98
                            "value": "Administrators"
99
                        }
100
                    }
101
                ],
102
                "issuelinks": [],
103
                "worklog": [],
104
                "updated": 1683288000000,
105
                "timetracking": {
106
                    "originalEstimate": "3h",
107
                    "remainingEstimate": "2h",
108
                    "timeSpent": "1h",
109
                    "originalEstimateSeconds": 10800,
110
                    "remainingEstimateSeconds": 7200,
111
                    "timeSpentSeconds": 3600
112
                }
113
            }
114
        }
115
    ],
116
    "warningMessages": []
117
}

Search Users
Copy

Returns a list of users that match the search string.

Sample Input

1
{
2
    "query": "john",
3
    "start_at": 0,
4
    "max_results": 2
5
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "active": true,
5
            "accountType": "atlassian",
6
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
7
            "name": "john.doe",
8
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5",
9
            "displayName": "John Doe",
10
            "emailAddress": "john.doe@example.com",
11
            "timeZone": "America/New_York",
12
            "locale": "en_US",
13
            "avatarUrls": {
14
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/48",
15
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/24",
16
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/16",
17
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/32"
18
            },
19
            "key": "john.doe"
20
        },
21
        {
22
            "active": true,
23
            "accountType": "atlassian",
24
            "accountId": "5b10ac8d82e05b22cc7d4ef6",
25
            "name": "john.smith",
26
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef6",
27
            "displayName": "John Smith",
28
            "emailAddress": "john.smith@example.com",
29
            "timeZone": "Europe/London",
30
            "locale": "en_GB",
31
            "avatarUrls": {
32
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/48",
33
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/24",
34
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/16",
35
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/32"
36
            },
37
            "key": "john.smith"
38
        }
39
    ]
40
}

Update version
Copy

Update a project version by its ID.

Sample Input

1
{
2
    "id": "10000",
3
    "name": "Version 2.0",
4
    "description": "Major release with new features",
5
    "project": "PROJ",
6
    "user_start_date": "2023-06-01T00:00:00.000Z",
7
    "user_release_date": "2023-12-31T23:59:59.999Z",
8
    "archived": false,
9
    "released": false
10
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
3
    "id": "10000",
4
    "description": "Major release with new features",
5
    "name": "Version 2.0",
6
    "archived": false,
7
    "released": false,
8
    "startDate": "2023-06-01T00:00:00.000Z",
9
    "releaseDate": "2023-12-31T23:59:59.999Z",
10
    "overdue": false,
11
    "userStartDate": "2023-06-01",
12
    "userReleaseDate": "2023-12-31",
13
    "projectId": 10001
14
}

DDL operations
Copy

List assignable users (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "accountId": "5b10a2844c20165700ede21g",
4
        "displayName": "John Doe",
5
        "emailAddress": "john.doe@example.com",
6
        "active": true,
7
        "timeZone": "America/New_York",
8
        "locale": "en_US",
9
        "avatarUrls": {
10
            "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/48",
11
            "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/24",
12
            "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/16",
13
            "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/32"
14
        }
15
    },
16
    {
17
        "accountId": "5b10a2844c20165700ede21h",
18
        "displayName": "Jane Smith",
19
        "emailAddress": "jane.smith@example.com",
20
        "active": true,
21
        "timeZone": "Europe/London",
22
        "locale": "en_GB",
23
        "avatarUrls": {
24
            "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/48",
25
            "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/24",
26
            "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/16",
27
            "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/32"
28
        }
29
    }
30
]

List issue fields (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "summary",
4
        "name": "Summary",
5
        "custom": false,
6
        "orderable": true,
7
        "navigable": true,
8
        "searchable": true,
9
        "clauseNames": [
10
            "summary"
11
        ],
12
        "schema": {
13
            "type": "string",
14
            "system": "summary"
15
        }
16
    },
17
    {
18
        "id": "description",
19
        "name": "Description",
20
        "custom": false,
21
        "orderable": true,
22
        "navigable": true,
23
        "searchable": true,
24
        "clauseNames": [
25
            "description"
26
        ],
27
        "schema": {
28
            "type": "string",
29
            "system": "description"
30
        }
31
    },
32
    {
33
        "id": "issuetype",
34
        "name": "Issue Type",
35
        "custom": false,
36
        "orderable": true,
37
        "navigable": true,
38
        "searchable": true,
39
        "clauseNames": [
40
            "issuetype",
41
            "type"
42
        ],
43
        "schema": {
44
            "type": "issuetype",
45
            "system": "issuetype"
46
        }
47
    },
48
    {
49
        "id": "priority",
50
        "name": "Priority",
51
        "custom": false,
52
        "orderable": true,
53
        "navigable": true,
54
        "searchable": true,
55
        "clauseNames": [
56
            "priority"
57
        ],
58
        "schema": {
59
            "type": "priority",
60
            "system": "priority"
61
        }
62
    },
63
    {
64
        "id": "customfield_10001",
65
        "name": "Story Points",
66
        "custom": true,
67
        "orderable": true,
68
        "navigable": true,
69
        "searchable": true,
70
        "clauseNames": [
71
            "cf[10001]",
72
            "Story Points"
73
        ],
74
        "schema": {
75
            "type": "number",
76
            "custom": "com.atlassian.jira.plugin.system.customfieldtypes:float",
77
            "customId": 10001
78
        }
79
    }
80
]

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "issueLinkTypes": [
3
        {
4
            "id": "10000",
5
            "name": "Blocks",
6
            "inward": "is blocked by",
7
            "outward": "blocks"
8
        },
9
        {
10
            "id": "10001",
11
            "name": "Cloners",
12
            "inward": "is cloned by",
13
            "outward": "clones"
14
        },
15
        {
16
            "id": "10002",
17
            "name": "Duplicate",
18
            "inward": "is duplicated by",
19
            "outward": "duplicates"
20
        },
21
        {
22
            "id": "10003",
23
            "name": "Relates",
24
            "inward": "relates to",
25
            "outward": "relates to"
26
        }
27
    ]
28
}

List issue transitions (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "transitions": [
3
        {
4
            "id": "11",
5
            "name": "To Do",
6
            "to": {
7
                "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
8
                "description": "This issue is ready to be worked on.",
9
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
10
                "name": "To Do",
11
                "id": "10000",
12
                "statusCategory": {
13
                    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
14
                    "id": 2,
15
                    "key": "new",
16
                    "colorName": "blue-gray",
17
                    "name": "To Do"
18
                }
19
            }
20
        },
21
        {
22
            "id": "21",
23
            "name": "In Progress",
24
            "to": {
25
                "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
26
                "description": "This issue is being actively worked on.",
27
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
28
                "name": "In Progress",
29
                "id": "3",
30
                "statusCategory": {
31
                    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/4",
32
                    "id": 4,
33
                    "key": "indeterminate",
34
                    "colorName": "yellow",
35
                    "name": "In Progress"
36
                }
37
            }
38
        },
39
        {
40
            "id": "31",
41
            "name": "Done",
42
            "to": {
43
                "self": "https://your-domain.atlassian.net/rest/api/3/status/10001",
44
                "description": "This issue is completed.",
45
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/closed.png",
46
                "name": "Done",
47
                "id": "10001",
48
                "statusCategory": {
49
                    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/3",
50
                    "id": 3,
51
                    "key": "done",
52
                    "colorName": "green",
53
                    "name": "Done"
54
                }
55
            }
56
        }
57
    ]
58
}

List issue types (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "10000",
4
        "name": "Epic",
5
        "description": "A big user story that needs to be broken down.",
6
        "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10307&avatarType=issuetype"
7
    },
8
    {
9
        "id": "10001",
10
        "name": "Story",
11
        "description": "A user story.",
12
        "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10315&avatarType=issuetype"
13
    },
14
    {
15
        "id": "10002",
16
        "name": "Task",
17
        "description": "A task that needs to be done.",
18
        "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype"
19
    },
20
    {
21
        "id": "10003",
22
        "name": "Bug",
23
        "description": "A problem which impairs or prevents the functions of the product.",
24
        "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10303&avatarType=issuetype"
25
    }
26
]

List priorities (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "value": "1",
4
        "text": "Highest"
5
    },
6
    {
7
        "value": "2",
8
        "text": "High"
9
    },
10
    {
11
        "value": "3",
12
        "text": "Medium"
13
    },
14
    {
15
        "value": "4",
16
        "text": "Low"
17
    },
18
    {
19
        "value": "5",
20
        "text": "Lowest"
21
    }
22
]

List project IDs (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "options": [
3
        {
4
            "value": "10000",
5
            "text": "Project Alpha"
6
        },
7
        {
8
            "value": "10001",
9
            "text": "Project Beta"
10
        },
11
        {
12
            "value": "10002",
13
            "text": "Project Gamma"
14
        },
15
        {
16
            "value": "10003",
17
            "text": "Project Delta"
18
        },
19
        {
20
            "value": "10004",
21
            "text": "Project Epsilon"
22
        }
23
    ]
24
}

List project keys (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "projectKeys": [
3
        "PROJ",
4
        "DEV",
5
        "TEST",
6
        "PROD",
7
        "SUPPORT"
8
    ]
9
}

List project statuses (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "self": "https://your-domain.atlassian.net/rest/api/3/status/1",
4
        "statusCategory": {
5
            "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/1",
6
            "id": 1,
7
            "key": "done",
8
            "colorName": "green",
9
            "name": "Done"
10
        },
11
        "description": "This issue is considered finished, the resolution is correct.",
12
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/closed.png",
13
        "name": "Done",
14
        "id": "1",
15
        "statusColor": "#14892c"
16
    },
17
    {
18
        "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
19
        "statusCategory": {
20
            "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
21
            "id": 2,
22
            "key": "new",
23
            "colorName": "blue-gray",
24
            "name": "To Do"
25
        },
26
        "description": "The issue is open and ready for the assignee to start work on it.",
27
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
28
        "name": "To Do",
29
        "id": "3",
30
        "statusColor": "#42526e"
31
    },
32
    {
33
        "self": "https://your-domain.atlassian.net/rest/api/3/status/4",
34
        "statusCategory": {
35
            "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/4",
36
            "id": 4,
37
            "key": "indeterminate",
38
            "colorName": "yellow",
39
            "name": "In Progress"
40
        },
41
        "description": "This issue is being actively worked on at the moment by the assignee.",
42
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
43
        "name": "In Progress",
44
        "id": "4",
45
        "statusColor": "#ffd700"
46
    }
47
]

List project versions (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "versions": [
3
        {
4
            "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
5
            "id": "10000",
6
            "name": "Version 1.0",
7
            "archived": false,
8
            "released": true,
9
            "startDate": "2023-01-01",
10
            "releaseDate": "2023-03-15",
11
            "userStartDate": "01/Jan/23",
12
            "userReleaseDate": "15/Mar/23",
13
            "projectId": 10001
14
        },
15
        {
16
            "self": "https://your-domain.atlassian.net/rest/api/3/version/10001",
17
            "id": "10001",
18
            "name": "Version 1.1",
19
            "archived": false,
20
            "released": false,
21
            "startDate": "2023-04-01",
22
            "releaseDate": "2023-06-30",
23
            "userStartDate": "01/Apr/23",
24
            "userReleaseDate": "30/Jun/23",
25
            "projectId": 10001
26
        }
27
    ]
28
}

List resolutions (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "self": "https://your-domain.atlassian.net/rest/api/3/resolution/1",
4
        "id": "1",
5
        "description": "A fix for this issue is complete and tested.",
6
        "name": "Done",
7
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/resolved.png"
8
    },
9
    {
10
        "self": "https://your-domain.atlassian.net/rest/api/3/resolution/2",
11
        "id": "2",
12
        "description": "This issue won't be actioned.",
13
        "name": "Won't Do",
14
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/cancelled.png"
15
    },
16
    {
17
        "self": "https://your-domain.atlassian.net/rest/api/3/resolution/3",
18
        "id": "3",
19
        "description": "This issue is no longer relevant.",
20
        "name": "Obsolete",
21
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/abandoned.png"
22
    }
23
]

List resources (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "issue",
4
        "name": "Issue",
5
        "description": "Represents a Jira issue"
6
    },
7
    {
8
        "id": "project",
9
        "name": "Project",
10
        "description": "Represents a Jira project"
11
    },
12
    {
13
        "id": "user",
14
        "name": "User",
15
        "description": "Represents a Jira user"
16
    },
17
    {
18
        "id": "board",
19
        "name": "Board",
20
        "description": "Represents a Jira board"
21
    },
22
    {
23
        "id": "sprint",
24
        "name": "Sprint",
25
        "description": "Represents a Jira sprint"
26
    }
27
]

List statuses (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
[
2
    {
3
        "id": "1",
4
        "name": "To Do",
5
        "statusCategory": {
6
            "id": 2,
7
            "key": "new",
8
            "colorName": "blue-gray",
9
            "name": "To Do"
10
        }
11
    },
12
    {
13
        "id": "2",
14
        "name": "In Progress",
15
        "statusCategory": {
16
            "id": 4,
17
            "key": "indeterminate",
18
            "colorName": "yellow",
19
            "name": "In Progress"
20
        }
21
    },
22
    {
23
        "id": "3",
24
        "name": "Done",
25
        "statusCategory": {
26
            "id": 3,
27
            "key": "done",
28
            "colorName": "green",
29
            "name": "Done"
30
        }
31
    }
32
]
Previous

Overview

Next

Operations