Form API

The Form API controller provides an API to query forms.

Endpoints

Get form

Get the form details by formId and processDefinitionKey required parameters.

URL

/v1/forms/{formId}?processDefinitionKey={processDefinitionKey}

Method

GET

Request parameters

Parameter name	Type	Required	Description
formId	path	`true`	ID of the form
processDefinitionKey	query	`true`	Reference to the process definition

caution

The formId is a value generated by the internal Tasklist API and is distinct from the ID specified in the form editor. While the key returned to the API user when getting a task follows the format camunda-forms:bpmn:<formId>, only the <formId> segment is required to retrieve the form schema.

HTTP request example

curl -X 'GET' \
  'http://{host}/v1/forms/{formId}?processDefinitionKey={processDefinitionKey}' \
  -H 'accept: application/json' \
  -H 'Cookie: TASKLIST-SESSION={tasklistSessionId}'

Responses

HTTP status	Description	Response schema
200	On success	JSON object with `FormResponse` structure
404	An error is returned when the form with the `formId` and `processDefinitionKey` is not found.	JSON object with `Error` structure

Endpoints​

Get form​

URL​

Method​

Request parameters​

HTTP request example​

Responses​