Skip to main content

​
What can you do with it?

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.

​
How to use it?

​
Basic Command Structure

/your-jira-forms-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:
  • action - The action to perform (get, save, delete, submit, etc.)
  • issueIdOrKey - The Jira issue ID or key
  • formId - The form ID (for most actions)
Optional:
  • visibility - Form visibility (internal/external)
  • requestLanguage - Language for service desk forms
  • serviceDeskId - Service desk ID for portal forms
  • requestTypeId - Request type ID for portal forms

​
Tools

​
Get Form on Issue

Retrieve a specific form attached to an issue. Parameters:
  • issueIdOrKey (required) - The issue ID or key
  • formId (required) - The form ID
Example: 
/your-jira-forms-connection
action: get
issueIdOrKey: PROJ-123
formId: c18bde7a-d846-11ed-afa1-0242ac120002
Response: 
{
  "id": "c18bde7a-d846-11ed-afa1-0242ac120002",
  "updated": "2023-04-11T08:59:18Z",
  "design": {
    "settings": {
      "name": "New employee onboarding",
      "language": "en"
    }
  },
  "state": {
    "visibility": "internal",
    "status": "open",
    "answers": {}
  }
}

​
Save Form Answers

Save answers to a form on an issue. Parameters:
  • issueIdOrKey (required) - The issue ID or key
  • formId (required) - The form ID
  • answers (required) - Object with field answers
Example: 
/your-jira-forms-connection
action: save
issueIdOrKey: PROJ-123
formId: c18bde7a-d846-11ed-afa1-0242ac120002
answers: {"field-1": "Employee Name: John Doe", "field-2": "Department: Engineering"}
Response: 
{
  "id": "c18bde7a-d846-11ed-afa1-0242ac120002",
  "updated": "2023-04-11T09:15:22Z",
  "state": {
    "answers": {
      "field-1": "Employee Name: John Doe",
      "field-2": "Department: Engineering"
    }
  }
}

​
List Forms on Issue

Get all forms attached to an issue. Parameters:
  • issueIdOrKey (required) - The issue ID or key
Example: 
/your-jira-forms-connection
action: list
issueIdOrKey: PROJ-123
Response: 
[
  {
    "id": "form-123",
    "name": "Bug Report Form",
    "status": "open",
    "visibility": "internal"
  },
  {
    "id": "form-456",
    "name": "Feature Request Form",
    "status": "submitted",
    "visibility": "external"
  }
]

​
Add Form to Issue

Add a new form to an issue. Parameters:
  • issueIdOrKey (required) - The issue ID or key
  • formId (required) - Template form ID to add
  • name (required) - Name for the new form
  • visibility (optional) - Form visibility (internal/external)
Example: 
/your-jira-forms-connection
action: add
issueIdOrKey: PROJ-123
formId: template-form-789
name: Customer Feedback Form
visibility: external
Response: 
{
  "id": "new-form-012",
  "name": "Customer Feedback Form",
  "status": "open",
  "visibility": "external",
  "created": "2023-04-11T10:30:00Z"
}

​
Submit Form

Submit a form to lock it from further editing. Parameters:
  • issueIdOrKey (required) - The issue ID or key
  • formId (required) - The form ID
Example: 
/your-jira-forms-connection
action: submit
issueIdOrKey: PROJ-123
formId: c18bde7a-d846-11ed-afa1-0242ac120002
Response: 
{
  "status": "submitted"
}

​
Export Form

Export a form to PDF or Excel format. Parameters:
  • issueIdOrKey (required) - The issue ID or key
  • formId (required) - The form ID
  • format (required) - Export format (pdf/xlsx/answers)
Example: 
/your-jira-forms-connection
action: export
issueIdOrKey: PROJ-123
formId: c18bde7a-d846-11ed-afa1-0242ac120002
format: pdf
Response: 
{
  "downloadUrl": "Link to download the exported file",
  "contentType": "application/pdf"
}

​
Copy Forms Between Issues

Copy one or more forms from one issue to another. Parameters:
  • sourceIssueIdOrKey (required) - Source issue ID or key
  • targetIssueIdOrKey (required) - Target issue ID or key
  • formIds (required) - Array of form IDs to copy
Example: 
/your-jira-forms-connection
action: copy
sourceIssueIdOrKey: PROJ-123
targetIssueIdOrKey: PROJ-456
formIds: ["form-123", "form-456"]
Response: 
{
  "errors": [],
  "copiedForms": [
    {
      "id": "form-123",
      "newId": "form-789"
    },
    {
      "id": "form-456",
      "newId": "form-012"
    }
  ]
}

​
Get Service Desk Form

Get a form template for a service desk request type. Parameters:
  • serviceDeskId (required) - Service desk ID
  • requestTypeId (required) - Request type ID
  • requestLanguage (optional) - Language code
Example: 
/your-jira-forms-connection
action: getServiceDeskForm
serviceDeskId: 10001
requestTypeId: 63
requestLanguage: en
Response: 
{
  "id": "c18bde7a-d846-11ed-afa1-0242ac120002",
  "design": {
    "questions": {
      "q1": {
        "label": "What type of issue are you reporting?",
        "type": "dropdown",
        "required": true,
        "options": ["Bug", "Feature Request", "Support"]
      }
    }
  }
}

​
Notes

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).
⌘I