Cloud
Forms / Reference / REST API

Forms on Portal

Postman Collection
OpenAPI

APIs which handle forms in the portal (service desk).

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

GET

Get external form data on a request typeExperimental

Get all external form data for questions and default answers on a form added to a request type. Forms can be linked to external sources including Jira fields and data connections, with this API returning the latest responses on these linked fields.

Permissions required:

  • View Service Desk permission to view the service desk.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

serviceDeskId

string

Required
requestTypeId

integer

Required

Responses

The external field data for questions and answers on a form.

application/json

ExternalFieldDataResponse

A response containing all external data for questions and answers on a form.

GET/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form/externaldata
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form/externaldata' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 { "fields": {} }
GET

Get form on a request typeExperimental

Gets a form template as a JSON object on a request type.

Permissions required:

  • View Service Desk permission to view the service desk.
Scopes

Connect app scope requiredREAD

read:servicedesk-request

Request

Path parameters

serviceDeskId

string

Required
requestTypeId

integer

Required

Responses

Returned when the form is retrieved successfully.

application/json

PortalFormTemplate

The form template associated with a request type in the portal.

GET/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/form
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jira/forms/cloud/{cloudId}/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/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 20 21 22 23 24 25 26 27 { "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": { "portalRequestTypeIds": [ 63 ], "submitOnCreate": true, "validateOnCreate": true } }