Cloud
Forms / Reference / REST API

Forms on Project

Postman Collection
OpenAPI

APIs which handle forms on JSM projects.

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

Operations
GET/project/{projectIdOrKey}/form/{formId}PUT/project/{projectIdOrKey}/form/{formId}DEL/project/{projectIdOrKey}/form/{formId}GET/project/{projectIdOrKey}/formPOST/project/{projectIdOrKey}/form
GET

Get form templateExperimental

Gets a form template as a JSON object on a project.

Permissions required:

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:
read:jira-work

Request

Path parameters

projectIdOrKey

string

Required
formId

string

Required

Responses

Returned when the form template is retrieved successfully.

application/json

FormTemplate

The form template associated with a project.

GET/project/{projectIdOrKey}/form/{formId}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form/{formId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 { "id": "c18bde7a-d846-11ed-afa1-0242ac120002", "updated": "2023-04-11T08:59:18Z", "design": { "conditions": {}, "layout": [ {} ], "questions": {}, "sections": {}, "settings": { "name": "New employee onboarding", "language": "en", "submit": { "lock": true, "pdf": true } } }, "publish": { "jira": { "recommendedIssueRequestTypeIds": [ 92 ], "issueCreateIssueTypeIds": [ 109 ], "issueCreateRequestTypeIds": [ 111 ], "submitOnCreate": true, "validateOnCreate": true }, "portal": { "portalRequestTypeIds": [ 63 ], "submitOnCreate": true, "validateOnCreate": true } } }
PUT

Save form templateExperimental

Saves a form template on a project.

Permissions required:

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope required: WRITE

OAuth 2.0 scopes required:
manage:jira-project

Request

Path parameters

projectIdOrKey

string

Required
formId

string

Required

Request bodyapplication/json

A JSON object containing a form template to save.

design

FormDesignRequest

Required
publish

FormPublishing

Responses

Returned when the form template is saved successfully.

application/json

FormTemplateIndexEntry

A summary of a form template associated with a project.

PUT/project/{projectIdOrKey}/form/{formId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 curl --request PUT \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form/{formId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "design": { "conditions": {}, "layout": [ {} ], "questions": {}, "sections": {}, "settings": { "name": "New employee onboarding", "language": "en", "submit": { "lock": true, "pdf": true } } }, "publish": { "jira": { "recommendedIssueRequestTypeIds": [ 92 ], "issueCreateIssueTypeIds": [ 109 ], "issueCreateRequestTypeIds": [ 111 ], "submitOnCreate": true, "validateOnCreate": true }, "portal": { "portalRequestTypeIds": [ 63 ], "submitOnCreate": true, "validateOnCreate": true } } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "id": "<string>", "name": "<string>", "updated": "<string>", "portalRequestTypeIds": [ 77 ], "recommendedIssueRequestTypeIds": [ 136 ], "issueCreateIssueTypeIds": [ 64 ], "issueCreateRequestTypeIds": [ 66 ] }
DEL

Delete form templateExperimental

Deletes a form on a project. This won't affect existing issues that already use this form, or any copies of this form in other projects.

Permissions required:

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope required: DELETE

OAuth 2.0 scopes required:
manage:jira-project

Request

Path parameters

projectIdOrKey

string

Required
formId

string

Required

Responses

Returned when the form template is deleted successfully.

application/json

string

DEL/project/{projectIdOrKey}/form/{formId}
1 2 3 4 curl --request DELETE \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form/{formId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 "<string>"
GET

Get project form indexExperimental

Get a list of form templates associated with the project.

Permissions required:

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope required: READ

OAuth 2.0 scopes required:
read:jira-work

Request

Path parameters

projectIdOrKey

string

Required

Responses

The list of form templates on the project.

application/json

array<FormTemplateIndexEntry>

GET/project/{projectIdOrKey}/form
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 [ { "id": "<string>", "name": "<string>", "updated": "<string>", "portalRequestTypeIds": [ 77 ], "recommendedIssueRequestTypeIds": [ 136 ], "issueCreateIssueTypeIds": [ 64 ], "issueCreateRequestTypeIds": [ 66 ] } ]
POST

Create form templateExperimental

Creates a form template on a project.

Permissions required:

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope required: WRITE

OAuth 2.0 scopes required:
manage:jira-project

Request

Path parameters

projectIdOrKey

string

Required

Request bodyapplication/json

A JSON object containing the content for a form template.

design

FormDesignRequest

Required
publish

FormPublishing

Responses

Returned when the form template is created successfully.

application/json

FormIndexEntry

A summary of a form associated with an issue or request.

POST/project/{projectIdOrKey}/form
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 curl --request POST \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/project/{projectIdOrKey}/form' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "design": { "conditions": {}, "layout": [ {} ], "questions": {}, "sections": {}, "settings": { "name": "New employee onboarding", "language": "en", "submit": { "lock": true, "pdf": true } } }, "publish": { "jira": { "recommendedIssueRequestTypeIds": [ 92 ], "issueCreateIssueTypeIds": [ 109 ], "issueCreateRequestTypeIds": [ 111 ], "submitOnCreate": true, "validateOnCreate": true }, "portal": { "portalRequestTypeIds": [ 63 ], "submitOnCreate": true, "validateOnCreate": true } } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 { "id": "<string>", "formTemplate": { "id": "<string>" }, "internal": true, "submitted": true, "lock": true, "name": "<string>", "updated": "<string>" }

Rate this page: