APIs which handle forms on Jira issues.
To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorization.
Gets a single form on an issue as a complete JSON object.
Permissions required:
read:jira-workConnect app scope required: READ
string
Requiredstring
RequiredReturned when the form is retrieved successfully.
A form associated with an issue or request.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
"id": "c18bde7a-d846-11ed-afa1-0242ac120002",
"updated": "2023-04-11T08:59:18Z",
"design": {
"conditions": {},
"layout": [
{}
],
"questions": {},
"sections": {},
"settings": {
"name": "New employee onboarding",
"language": "en",
"submit": {
"lock": true,
"pdf": true
},
"primaryLocale": {
"language": "<string>",
"displayName": "<string>",
"country": "<string>",
"variant": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
},
"translatedLocale": {
"language": "<string>",
"displayName": "<string>",
"country": "<string>",
"variant": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
}
}
},
"state": {
"visibility": "i",
"status": "o",
"answers": {}
}
}Saves form answers on an issue.
Permissions required:
write:jira-workConnect app scope required: WRITE
string
Requiredstring
RequiredA request to save form answers.
object
RequiredReturned when form answers are successfully saved.
A form associated with an issue or request.
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"answers": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
"id": "c18bde7a-d846-11ed-afa1-0242ac120002",
"updated": "2023-04-11T08:59:18Z",
"design": {
"conditions": {},
"layout": [
{}
],
"questions": {},
"sections": {},
"settings": {
"name": "New employee onboarding",
"language": "en",
"submit": {
"lock": true,
"pdf": true
},
"primaryLocale": {
"language": "<string>",
"displayName": "<string>",
"country": "<string>",
"variant": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
},
"translatedLocale": {
"language": "<string>",
"displayName": "<string>",
"country": "<string>",
"variant": "<string>",
"script": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
}
}
},
"state": {
"visibility": "i",
"status": "o",
"answers": {}
}
}Deletes a form from an issue.
Permissions required:
write:jira-workConnect app scope required: DELETE
string
Requiredstring
RequiredReturned when the form is deleted successfully.
string
1
2
3
4
curl --request DELETE \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
"<string>"Retrieve metadata for all attachments in a form on an issue.
Permissions required:
read:jira-workConnect app scope required: READ
string
Requiredstring
RequiredReturned when the metadata associated with the attachment fields on the form are successfully retrieved.
A response containing all the form's attachments.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/attachment' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"fields": {}
}Get all external form data for questions and answers on a form on an issue. Forms can be linked to external sources including Jira fields and data connections, with this API returning the latest responses on these linked fields.
Permissions required:
read:jira-workConnect app scope required: READ
string
Requiredstring
RequiredThe external field data for questions and answers on a form.
A response containing all external data for questions and answers on a form.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/externaldata' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"fields": {}
}Changes the visibility of a form on an issue from internal only to external. External forms can be viewed in the portal by customers.
Permissions required:
write:jira-workConnect app scope required: WRITE
string
Requiredstring
RequiredReturned when the form is successfully set to external.
The visibility of a form on an issue or request.
1
2
3
4
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/external' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"visibility": "internal"
}Changes the visibility of a form on an issue from external to internal only. Internal forms can not be viewed in the portal by customers.
Permissions required:
write:jira-workConnect app scope required: WRITE
string
Requiredstring
RequiredReturned when the form is successfully set to internal.
The visibility of a form on an issue or request.
1
2
3
4
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/internal' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"visibility": "internal"
}Gets a list of forms on the issue with basic metadata about them.
Permissions required:
read:jira-workConnect app scope required: READ
string
RequiredThe list of forms on the issue.
array<FormIndexEntry>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
[
{
"id": "<string>",
"formTemplate": {
"id": "<string>"
},
"internal": true,
"submitted": true,
"lock": true,
"name": "<string>",
"updated": "<string>"
}
]Adds a form template to an issue.
Permissions required:
write:jira-workConnect app scope required: WRITE
string
RequiredA request specifying an attach form.
FormTemplateRef
RequiredReturned when the form template is attached successfully.
A summary of a form associated with an issue or request.
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"formTemplate": {
"id": "<string>"
}
}'1
2
3
4
5
6
7
8
9
10
11
{
"id": "<string>",
"formTemplate": {
"id": "<string>"
},
"internal": true,
"submitted": true,
"lock": true,
"name": "<string>",
"updated": "<string>"
}Gets a single form on an issue as a PDF file.
Permissions required:
read:jira-workConnect app scope required: READ
string
Requiredstring
RequiredReturned when the pdf is retrieved successfully.
string
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/pdf' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/pdf'Gets a single form on an issue as an XLSX file.
Permissions required:
read:jira-workConnect app scope required: READ
string
Requiredstring
RequiredReturned when the xlsx is retrieved successfully.
string
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/xlsx' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'Changes the status of a form on an issue to submitted.
Depending on how the form is configured the form may either enter the submitted state or the locked state. Locked forms are considered to be submitted and locked and can only be reopened by project admins.
The current iteration of this API does not check that form answers are valid.
Permissions required:
write:jira-workConnect app scope required: WRITE
string
Requiredstring
RequiredReturned when the form is submitted successfully.
A response indicating the current status of a form on an issue or request.
1
2
3
4
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/submit' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"status": "open"
}Changes the status of a submitted form on an issue to open to enable editing. Locked forms can only be reopened by a project admin.
Permissions required:
Browse projects and Edit issues project permission for the project that the issue is in.
If issue-level security is configured, issue-level security permission to view the issue.
Administer Jira project permission if the form is locked.
write:jira-workConnect app scope required: WRITE
string
Requiredstring
RequiredReturned when the form is reopened successfully.
A response indicating the current status of a form on an issue or request.
1
2
3
4
curl --request PUT \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/reopen' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
{
"status": "open"
}Copy forms from one issue to another.
Permissions required:
write:jira-workConnect app scope required: WRITE
string
Requiredstring
RequiredA request with a list of form IDs to copy.
array<FormId>
Returned when the forms are copied successfully, or with partial success.
Response after copying forms.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{sourceIssueIdOrKey}/form/copy/{targetIssueIdOrKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"ids": [
{
"value": "<string>"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"errors": [
{
"id": "<string>",
"status": 28,
"code": "<string>",
"title": "<string>",
"detail": "<string>",
"context": [
{
"type": "<string>",
"id": "<string>"
}
]
}
],
"copiedForms": [
{
"id": "<string>",
"newId": "<string>"
}
]
}Gets the answers from a form on an issue that are simplified into a flattened list for scripting tool ease of use. Multivalued answers will be flattened to a comma-separated string.
Permissions required:
read:jira-workConnect app scope required: READ
string
Requiredstring
RequiredReturned when the form answers are retrieved successfully.
array<FormSimplifiedAnswer>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/answers' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
[
{
"label": "<string>",
"fieldKey": "<string>",
"answer": "<string>",
"choice": "<string>"
}
]Rate this page: