Rate this page:
APIs which handle forms on Jira issues.
To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorisation.
GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/xlsx
Gets a single form on an issue as an XLSX file.
Permissions required:
read:jira-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the xlsx is retrieved successfully.
Content type | Value |
---|---|
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | string |
GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/answers
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-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the form answers are retrieved successfully.
Content type | Value |
---|---|
application/json | Array<FormSimplifiedAnswer> |
GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form
Gets a list of forms on the issue with basic metadata about them.
Permissions required:
read:jira-work
string
The issue key or ID
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'
The list of forms on the issue.
Content type | Value |
---|---|
application/json | Array<FormIndexEntry> |
POST /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form
Adds a form template to an issue.
Permissions required:
write:jira-work
string
The issue key or ID
A request indicating a form to be attached to an issue.
Metadata of the template the form was created from.
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>"
}
}'
Returned when the form template is attached successfully.
Content type | Value |
---|---|
application/json |
PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/external
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-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the form is successfully set to external.
Content type | Value |
---|---|
application/json |
PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/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-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the form is successfully set to internal.
Content type | Value |
---|---|
application/json |
GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}
Gets a single form on an issue as a complete JSON object.
Permissions required:
read:jira-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the form is retrieved successfully.
Content type | Value |
---|---|
application/json |
DELETE /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}
Deletes a form from an issue.
Permissions required:
write:jira-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the form is deleted successfully.
Content type | Value |
---|---|
application/json | string |
GET /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/format/pdf
Gets a single form on an issue as a PDF file.
Permissions required:
read:jira-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the pdf is retrieved successfully.
Content type | Value |
---|---|
application/pdf | string |
PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/submit
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-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the form is submitted successfully.
Content type | Value |
---|---|
application/json |
PUT /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}/action/reopen
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-work
string
The issue key or ID
string
The ID of the form
uuid
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'
Returned when the form is reopened successfully.
Content type | Value |
---|---|
application/json |
POST /jira/forms/cloud/{cloudId}/issue/{sourceIssueIdOrKey}/form/copy/{targetIssueIdOrKey}
Copy forms from one issue to another.
Permissions required:
write:jira-work
string
The source issue key or ID
string
The target issue key or ID
A request indicating the form IDs on an issue to be copied.
Array<string>
An array of form IDs. If not specified, copies all forms.
1 2 3 4 5 6 7 8 9 10
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": [
"<string>"
]
}'
Returned when the forms are copied successfully, or with partial success.
Content type | Value |
---|---|
application/json |
Rate this page: