The pdfToolbox Rest API - Operation: Retrieve Profile Variables
The Retrieve Profile Variables operation returns the variables defined by a Preflight profile.
Applications typically call this operation before executing a Preflight request to determine which variables a selected profile accepts and which values should be supplied.
When to use
Use this operation when your application needs to configure a Preflight profile dynamically.
Typical use cases include:
- Building a user interface that displays profile-specific options.
- Validating user input before running a Preflight profile.
- Discovering which variables are available for a selected profile.
- Supporting custom or configurable processing workflows.
Endpoint
Submit a POST request to the Retrieve Profile Variables endpoint.
The request is processed asynchronously and follows the same execution model as all other REST API operations. See Overview for details about the processing workflow.
Request
A request consists of the Preflight profile whose variables should be retrieved.
No input PDF is required because the operation only inspects the selected profile.
Response
After processing has completed, the operation returns the variables defined by the selected profile.
For each variable, the response may include information such as:
- the variable key,
- a display name or description,
- the expected value type,
- default values, where applicable.
The returned information can be used to build a user interface or construct a valid Preflight request.
Typical workflow
A common workflow is:
- Select a Preflight profile.
- Retrieve the variables supported by that profile.
- Collect the required variable values from the user or another system.
- Submit the Preflight request with the completed variable set.
Related topics
- Preflight Execute the selected profile.
- Using Variables Learn how to include variables in a Preflight request.