Forms Export
Forms on Issue
Forms on Project

Rate this page:

Forms on Issue

APIs which handle forms on Jira issues.

To learn about the appropriate URI structure for your chosen authentication method, view authentication and authorisation.

Get form XLSX

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the xlsx is retrieved successfully.

Content typeValue
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

string

Get form simplified answers

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the form answers are retrieved successfully.

Content typeValue
application/json

Array<FormSimplifiedAnswer>

Get form index

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

Example

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'

Responses

The list of forms on the issue.

Content typeValue
application/json

Array<FormIndexEntry>

Add form

Experimental

POST /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form

Adds a form template to an issue.

Permissions required:

write:jira-work

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

Body parameters

A request indicating a form to be attached to an issue.

formTemplate Required

FormTemplateRef

Metadata of the template the form was created from.

Example

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>"
  }
}'

Responses

Returned when the form template is attached successfully.

Content typeValue
application/json

FormIndexEntry

Change visibility to external

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the form is successfully set to external.

Content typeValue
application/json

FormVisibilityResponse

Change visibility to internal

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the form is successfully set to internal.

Content typeValue
application/json

FormVisibilityResponse

Get form

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the form is retrieved successfully.

Content typeValue
application/json

Form

Delete form

Experimental

DELETE /jira/forms/cloud/{cloudId}/issue/{issueIdOrKey}/form/{formId}

Deletes a form from an issue.

Permissions required:

write:jira-work

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the form is deleted successfully.

Content typeValue
application/json

string

Get form PDF

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the pdf is retrieved successfully.

Content typeValue
application/pdf

string

Submit form

Experimental

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

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the form is submitted successfully.

Content typeValue
application/json

FormStatusResponse

Reopen form

Experimental

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:

write:jira-work

Request

Path parameters
issueIdOrKey Required

string

The issue key or ID

formId Required

string

The ID of the form

Format: uuid

Example

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'

Responses

Returned when the form is reopened successfully.

Content typeValue
application/json

FormStatusResponse

Copy forms

Experimental

POST /jira/forms/cloud/{cloudId}/issue/{sourceIssueIdOrKey}/form/copy/{targetIssueIdOrKey}

Copy forms from one issue to another.

Permissions required:

write:jira-work

Request

Path parameters
sourceIssueIdOrKey Required

string

The source issue key or ID

targetIssueIdOrKey Required

string

The target issue key or ID

Body parameters

A request indicating the form IDs on an issue to be copied.

ids

Array<string>

An array of form IDs. If not specified, copies all forms.

Example

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>"
  ]
}'

Responses

Returned when the forms are copied successfully, or with partial success.

Content typeValue
application/json

CopyFormsResponse

Rate this page: