> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# jira-forms

> Form management

**Server path:** `/jira-forms` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                        | Description                        |
| ----------------------------------------------------------- | ---------------------------------- |
| [`jira_forms_create_form`](#jira_forms_create_form)         | Create a new form in Jira Forms    |
| [`jira_forms_get_form`](#jira_forms_get_form)               | Get form details by ID             |
| [`jira_forms_list_forms`](#jira_forms_list_forms)           | List all forms in the organization |
| [`jira_forms_get_submissions`](#jira_forms_get_submissions) | Get form submissions               |
| [`jira_forms_update_form`](#jira_forms_update_form)         | Update an existing form            |

***

## jira\_forms\_create\_form

Create a new form in Jira Forms

**Parameters:**

| Parameter     | Type      | Required | Default | Description                                 |
| ------------- | --------- | -------- | ------- | ------------------------------------------- |
| `name`        | string    | Yes      | —       | Form name                                   |
| `description` | string    | No       | —       | Form description                            |
| `projectKey`  | string    | Yes      | —       | Jira project key to associate form with     |
| `issueType`   | string    | Yes      | —       | Issue type to create when form is submitted |
| `fields`      | object\[] | Yes      | —       | Form fields                                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "name": {
        "type": "string",
        "description": "Form name"
      },
      "description": {
        "type": "string",
        "description": "Form description"
      },
      "projectKey": {
        "type": "string",
        "description": "Jira project key to associate form with"
      },
      "issueType": {
        "type": "string",
        "description": "Issue type to create when form is submitted"
      },
      "fields": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "text",
                "textarea",
                "select",
                "multiselect",
                "checkbox",
                "radio",
                "date",
                "email"
              ],
              "description": "Field type"
            },
            "label": {
              "type": "string",
              "description": "Field label"
            },
            "required": {
              "type": "boolean",
              "default": false,
              "description": "Whether field is required"
            },
            "options": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Options for select/radio fields"
            }
          }
        },
        "description": "Form fields"
      }
    },
    "required": [
      "PCID",
      "name",
      "projectKey",
      "issueType",
      "fields"
    ]
  }
  ```
</Expandable>

***

## jira\_forms\_get\_form

Get form details by ID

**Parameters:**

| Parameter | Type   | Required | Default | Description         |
| --------- | ------ | -------- | ------- | ------------------- |
| `formId`  | string | Yes      | —       | Form ID to retrieve |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "formId": {
        "type": "string",
        "description": "Form ID to retrieve"
      }
    },
    "required": [
      "PCID",
      "formId"
    ]
  }
  ```
</Expandable>

***

## jira\_forms\_list\_forms

List all forms in the organization

**Parameters:**

| Parameter    | Type   | Required | Default | Description                       |
| ------------ | ------ | -------- | ------- | --------------------------------- |
| `projectKey` | string | No       | —       | Filter by project key             |
| `limit`      | number | No       | `50`    | Maximum number of forms to return |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "projectKey": {
        "type": "string",
        "description": "Filter by project key"
      },
      "limit": {
        "type": "number",
        "default": 50,
        "description": "Maximum number of forms to return"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## jira\_forms\_get\_submissions

Get form submissions

**Parameters:**

| Parameter   | Type   | Required | Default | Description                             |
| ----------- | ------ | -------- | ------- | --------------------------------------- |
| `formId`    | string | Yes      | —       | Form ID to get submissions for          |
| `startDate` | string | No       | —       | Start date for submissions (YYYY-MM-DD) |
| `endDate`   | string | No       | —       | End date for submissions (YYYY-MM-DD)   |
| `limit`     | number | No       | `100`   | Maximum number of submissions to return |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "formId": {
        "type": "string",
        "description": "Form ID to get submissions for"
      },
      "startDate": {
        "type": "string",
        "description": "Start date for submissions (YYYY-MM-DD)"
      },
      "endDate": {
        "type": "string",
        "description": "End date for submissions (YYYY-MM-DD)"
      },
      "limit": {
        "type": "number",
        "default": 100,
        "description": "Maximum number of submissions to return"
      }
    },
    "required": [
      "PCID",
      "formId"
    ]
  }
  ```
</Expandable>

***

## jira\_forms\_update\_form

Update an existing form

**Parameters:**

| Parameter     | Type    | Required | Default | Description              |
| ------------- | ------- | -------- | ------- | ------------------------ |
| `formId`      | string  | Yes      | —       | Form ID to update        |
| `name`        | string  | No       | —       | Updated form name        |
| `description` | string  | No       | —       | Updated form description |
| `active`      | boolean | No       | —       | Whether form is active   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "formId": {
        "type": "string",
        "description": "Form ID to update"
      },
      "name": {
        "type": "string",
        "description": "Updated form name"
      },
      "description": {
        "type": "string",
        "description": "Updated form description"
      },
      "active": {
        "type": "boolean",
        "description": "Whether form is active"
      }
    },
    "required": [
      "PCID",
      "formId"
    ]
  }
  ```
</Expandable>