Use this file to discover all available pages before exploring further.
Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.
Payload schemas for data access audit log events. Each table lists the attributes returned in the object.attributes field of the event payload for the given eventAction. Data access events use source: ExpressApi. For the full list of eventAction values, see Audit Logs.
Data Model Records
create-model-records
Attribute
Description
Type
userId
The unique identifier of the Creator who created the records.
String
size
The size of the record payload in bytes.
Integer
get-model-records
Attribute
Description
Type
userId
The unique identifier of the Creator who retrieved the records.
String
modelId
The unique identifier of the data model.
String
options.skip
The number of records skipped in the query.
Integer
options.limit
The maximum number of records to retrieve.
Integer
options.filter
The filter applied when retrieving records.
Object
options.project
The columns excluded from the results.
Object
options.count
Whether the count query was used.
Boolean
update-model-record
Attribute
Description
Type
userId
The unique identifier of the Creator who updated the record.
String
recordId
The unique identifier of the data model record.
String
modelId
The unique identifier of the data model.
String
strictValidation
Whether the record was updated successfully.
Boolean
Module Submissions
create-module-submissions
Attribute
Description
Type
transformName
The name of the transform applied to the submission data.
String
userId
The unique identifier of the Express user who created the submission.
String
metadata
The submission's metadata.
Object
size
The size of the submission payload in bytes.
Integer
get-module-submissions
Attribute
Description
Type
transformName
The name of the transform applied to the submission data.
String
limit
The maximum number of submissions returned.
Integer
offset
The number of submissions skipped.
Integer
sortBy
The field used to sort submissions.
String
sortOrder
The sort order (ascending or descending).
Integer
includeDeleted
Whether deleted submissions are included.
Boolean
metadataFilter
The filter applied to submission metadata.
String
includeRaw
Whether raw untransformed submission data is included.
Boolean
includeBase64
Whether Base64PDF data and PDF URLs are included.
Boolean
resolveCloudStorageUrls
Whether cloud storage URLs are resolved to Base64 data.
Boolean
filter
The filter applied to submission data.
String
get-module-submission
Attribute
Description
Type
moduleId
The unique identifier of the module where the submission was retrieved.
String
transformName
The name of the transform applied to the submission data.
String
includeRaw
Whether raw untransformed submission data is included.
Boolean
includeBase64
Whether Base64 PDF data and PDF URLs are included.
Boolean
resolveCloudStorageUrls
Whether cloud storage URLs are resolved to Base64 data.
Boolean
get-merged-submissions
Attribute
Description
Type
submissionIds
The unique identifiers of the submissions that were merged.
String
conflictCheckFields
Validation of any conflicts that occurred in the merge.
String
reportConflicts
Whether conflicts were reported during the merge.
String
sortBy
The field used to sort the merged data.
String
sortOrder
The sort order.
String
get-moduleandworkflow-submissions
Attribute
Description
Type
limit
The maximum number of submissions returned.
Integer
offset
The number of submissions skipped.
Integer
sortBy
The field used to sort submissions.
String
sortOrder
The sort order.
Integer
includeDeleted
Whether deleted submissions are included.
Boolean
metadataFilter
The filter applied to submission metadata.
String
update-module-submission
Attribute
Description
Type
moduleId
The unique identifier of the module where the submission was updated.
String
transformName
The name of the transform applied to the submission data.
String
replaceData
Whether the entire submission data object was replaced.
Boolean
userId
The unique identifier of the Express user who updated the submission.
String
dataFilter
Filtered submissions based on their data.
Object
unsetData
Submission data keys that were deleted.
Object
metadata
The submission's metadata.
Object
metadataFilter
Filtered submissions based on their metadata.
Object
unsetMetadata
Submission metadata keys that were deleted.
Object
update-module-submissions
Attribute
Description
Type
replaceData
Whether the entire submission data object was replaced.
Boolean
requestBody.id
The unique identifier of the submission that was updated.
String
requestBody.dataFilter
Filtered submissions based on their data.
Object
requestBody.unsetData
Submission data keys that were deleted.
Object
requestBody.metadata
The submission's metadata.
Object
requestBody.metadataFilter
Filtered submissions based on their metadata.
Object
requestBody.unsetMetadata
Submission metadata keys that were deleted.
Object
delete-module-submission
Attribute
Description
Type
moduleId
The unique identifier of the module where the submission was deleted.
String
destroy
Whether the submission was permanently deleted.
Boolean
delete-module-submissions
Attribute
Description
Type
destroy
Whether the submissions were permanently deleted.
Boolean
ids
The unique identifiers of the deleted submissions.
String
restore-module-submission
Attribute
Description
Type
moduleId
The unique identifier of the module where the submission was restored.
String
Workflow Submissions
get-workflow-submissions
Attribute
Description
Type
transformName
The name of the transform applied to the submission data.
String
limit
The maximum number of submissions returned.
Integer
offset
The number of submissions skipped.
Integer
sortBy
The field used to sort submissions.
String
sortOrder
The sort order.
Integer
includeDeleted
Whether deleted submissions are included.
Boolean
metadataFilter
The filter applied to submission metadata.
String
includeRaw
Whether raw untransformed submission data is included.
Boolean
includeBase64
Whether Base64 PDF data and PDF URLs are included.
Boolean
resolveCloudStorageUrls
Whether cloud storage URLs are resolved to Base64 data.
Boolean
filter
The filter applied to submission data.
String
get-workflow-submission
Attribute
Description
Type
workflowId
The unique identifier of the workflow where the submission was retrieved.
String
transformName
The name of the transform applied to the submission data.
String
includeRaw
Whether raw untransformed submission data is included.
Boolean
includeBase64
Whether Base64 PDF data and PDF URLs are included.
Boolean
resolveCloudStorageUrls
Whether cloud storage URLs are resolved to Base64 data.
Boolean
update-workflow-submission
Attribute
Description
Type
workflowId
The unique identifier of the workflow where the submission was updated.
String
replaceData
Whether the entire submission data object was replaced.
Boolean
userId
The unique identifier of the Express user who updated the submission.
String
dataFilter
Filtered submissions based on their data.
Object
unsetData
Submission data keys that were deleted.
Object
metadata
The submission's metadata.
Object
metadataFilter
Filtered submissions based on their metadata.
Object
unsetMetadata
Submission metadata keys that were deleted.
Object
currentStatus
The current status of the submission.
String
delete-workflow-submission
Attribute
Description
Type
workflowId
The unique identifier of the workflow where the submission was deleted.
String
destroy
Whether the submission was permanently deleted.
Boolean
delete-workflow-submissions
Attribute
Description
Type
destroy
Whether the submissions were permanently deleted.
Boolean
ids
The unique identifiers of the deleted submissions.
String
restore-workflow-submission
Attribute
Description
Type
workflowId
The unique identifier of the workflow where the submission was restored.
String
Changelog
Date
Change
2026-09-11
Initial publication (EN-8100).
An API payload is the data that is sent or received between a client and a server during an API request or response. It contains the information needed to perform actions or get resources.
Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.
A query lets you retrieve, access, manipulate, and delete data in a database.
The Boolean data type accepts one of two values: true, or, false.
The Unqork front-end application framework that delivers Creator-built applications to end-users. Express is the layer end-users interact with—the published forms, screens, and navigation built in the Module Builder. Express is distinct from Express View, which is a Creator-facing preview tool in the IDE.
Base64 is an encoding and decoding technique used to convert binary data to an ASCII (American Standard for Information Interchange) text format.
PDF (Portable Document Format) is a file format that allows users to share and print documents without modifying them.
An app versioning Merge combines changes from one branch or draft, into another branch, draft, or published version of an application.
An object is a type of data structure that represents a single, self-contained entity that acts as a container for the characteristics of that entity.
A key-value pair is a fundamental data structure where a unique "key" is associated with a specific "value," used for organizing and retrieving data efficiently, like in dictionaries or databases.