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

Send a token issue GET request to the authorization server with the following content:

{
  "form_id": "<form-id>",
  "process_definition_key": "<process-definition-key>",
  "version": "<version>",
}

Refer to the following example with curl:

curl -X 'GET' \
  'http://{host}/v1/forms/{formId}?processDefinitionKey={processDefinitionKey}&version={formVersion}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {yourBearerToken}'

See details on Tasklist API (REST) authentication if you have not already authenticated.

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