Documentation Index

Fetch the complete documentation index at: https://docs.unqork.io/llms.txt

Use this file to discover all available pages before exploring further.

Querying Submissions

Prev Next

The Unqork submissions endpoint retrieves module , with support for filtering by end-user or date, sorting, pagination, and field selection. It is most commonly called through the Plug-In component.

Endpoint

GET /modules/{moduleId}/submissions

Returns an array of submission objects for the specified module. See Submission Data Structure for the structure of each object.

Parameters

Pagination

Parameter Type Default Maximum Description
limit Number 50 50 Number of submissions to return.
offset Number 0 Number of submissions to skip before returning results. Zero-based.

To retrieve all submissions when the total count exceeds 50, paginate with successive requests using offset. The response includes a Link header with rel=next pointing to the next page. When rel=next is absent, all submissions have been returned. See Pagination in the Platform Limits article for details.

Sorting

Parameter Type Options Description
sortBy String created, modified The field to sort results by.
sortOrder Number 1 (ascending), -1 (descending) The sort direction.

Filtering

Use the filter parameter to narrow results. Separate multiple filter conditions with ;.

Supported filter fields: userId, created, modified

Supported operators:

Operator Syntax Example
Equal key=val filter=userId=jane@example.com
Greater than key>val filter=created>2026-01-01T00:00:00.000Z
Greater than or equal key>=val filter=created>=2026-01-01T00:00:00.000Z
Less than key<val filter=created<2026-06-01T00:00:00.000Z
Less than or equal key<=val filter=created<=2026-06-01T00:00:00.000Z
Not equal key!=val filter=userId!=admin@example.com
Multiple values key=val1,val2 filter=userId=jane@example.com,john@example.com
RegEx key=/pattern/<opts> filter=userId=/@company\.com$/i

All timestamps in filter conditions must be in UTC ISO 8601 format. For example: 2026-03-19T00:00:00.000Z.

Filter examples:

filter=userId=jane@example.com
filter=userId=jane@example.com;created>2026-01-01T00:00:00.000Z
filter=created>2026-01-01T00:00:00.000Z;created<2026-06-01T00:00:00.000Z

Additional Options

Parameter Type Description
transformName String A configured output Transform to apply to the returned data.
includeDeleted Boolean When true, includes soft-deleted submissions in results.
includeRaw Boolean When true, includes the untransformed rawData alongside any Transform output.
resolveCloudStorageUrls Boolean When true, resolves cloud storage URLs in rawData to their base64 values.

Pagination Example

To retrieve all submissions when there are more than 50, paginate through results using offset. Check the Link response header for rel=next to determine whether more submissions exist.

First request:

GET /modules/{moduleId}/submissions?limit=50&offset=0

Response headers (more records exist):

Link: <.../submissions?limit=50&offset=50>; rel=next

Second request (records 51–100):

GET /modules/{moduleId}/submissions?limit=50&offset=50

Third request (records 101 onward):

GET /modules/{moduleId}/submissions?limit=50&offset=100

When the response Link header contains no rel=next, all submissions have been returned.


Changelog

Date Change
Initial publication.