Manage Jira Forms including creating, editing, submitting, and exporting forms attached to issues and service desk requests
The Jira Forms API allows you to manage forms attached to Jira issues and service desk request types. You can create, edit, submit, and export forms, manage form visibility, copy forms between issues, and handle form attachments and external data.
Required:
action
- The action to perform (get, save, delete, submit, etc.)issueIdOrKey
- The Jira issue ID or keyformId
- The form ID (for most actions)Optional:
visibility
- Form visibility (internal/external)requestLanguage
- Language for service desk formsserviceDeskId
- Service desk ID for portal formsrequestTypeId
- Request type ID for portal formsRetrieve a specific form attached to an issue.
Parameters:
issueIdOrKey
(required) - The issue ID or keyformId
(required) - The form IDExample:
Response:
Save answers to a form on an issue.
Parameters:
issueIdOrKey
(required) - The issue ID or keyformId
(required) - The form IDanswers
(required) - Object with field answersExample:
Response:
Get all forms attached to an issue.
Parameters:
issueIdOrKey
(required) - The issue ID or keyExample:
Response:
Add a new form to an issue.
Parameters:
issueIdOrKey
(required) - The issue ID or keyformId
(required) - Template form ID to addname
(required) - Name for the new formvisibility
(optional) - Form visibility (internal/external)Example:
Response:
Submit a form to lock it from further editing.
Parameters:
issueIdOrKey
(required) - The issue ID or keyformId
(required) - The form IDExample:
Response:
Export a form to PDF or Excel format.
Parameters:
issueIdOrKey
(required) - The issue ID or keyformId
(required) - The form IDformat
(required) - Export format (pdf/xlsx/answers)Example:
Response:
Copy one or more forms from one issue to another.
Parameters:
sourceIssueIdOrKey
(required) - Source issue ID or keytargetIssueIdOrKey
(required) - Target issue ID or keyformIds
(required) - Array of form IDs to copyExample:
Response:
Get a form template for a service desk request type.
Parameters:
serviceDeskId
(required) - Service desk IDrequestTypeId
(required) - Request type IDrequestLanguage
(optional) - Language codeExample:
Response:
Supports both issue-based forms and service desk portal forms. Form exports are available in PDF, Excel, and simplified answer formats. Form visibility can be set to internal (team only) or external (customer-facing).