Record Collections exposes 13 API functions for reading and managing records and bulk jobs. These functions power the Record Collections UI and serve as a reference for the underlying platform API endpoints.
The functions are grouped into four areas: Collections, Records, Bulk Operations, and Client-Only.
Collections
These functions retrieve information about collections in a workspace.
Retrieve record counts and active job indicators for a set of collection IDs. The endpoint used depends on the collection type.
Records
These functions retrieve individual records or lists of records.
Function
Method
Endpoint
Description
getRecords
GET
/records
List records for a collection. Filter by includeActive and includeDeleted. Supports limit and offset for pagination.
getRecord
GET
/records/:recordId
Retrieve a single record by ID. Accepts options to include archived or deleted records.
Bulk Operations
These functions create and manage import and export jobs.
Function
Method
Endpoint
Description
createExportJob
POST
/bulkOperations/export
Begin an export job for a collection. Parameters: name, fileFormat, exportFullRecord, numberOfFilesToGenerate, resourceId, targetRecordType (ALL, ACTIVE, or ARCHIVED).
createImportJob
POST
/bulkOperations/import
Begin an import job for a collection. Parameters: name, fallbackRecordOwner, fileFormat, fileLocation, resourceId, storeInData.
createUploadLink
POST
/bulkOperations/uploadLink
Generate a pre-signed upload URL. Call this before createImportJob to retrieve the upload destination. The returned URL is passed to uploadFile.
createDownloadLink
POST
/bulkOperations/downloadLink
Generate a download URL for a completed export batch file. Pass the fileLocation from the batch record.
getJobs
GET
/bulkOperations/jobs
List jobs for a collection, paginated. Uses dataModelId for Data Model collections and moduleId for all other collection types.
getJob
GET
/bulkOperations/jobs/:jobId
Retrieve the current state of a single job, including its batches and status.
cancelJob
POST
/bulkOperations/jobs/:jobId/cancel
Cancel a running job. Terminal jobs (Completed, Failed, Canceled) cannot be canceled.
Client-Only Functions
These two functions require browser APIs and cannot be called from server actions.
Function
Description
getServiceUsers
Retrieve service users available as fallback record owners during import.
uploadFile
POST a file to the pre-signed upload URL returned by createUploadLink. Returns a fileKey that is passed to createImportJob as the fileLocation parameter. Maximum file size is 100 MB.
Import Flow
The import process uses the following three functions in sequence:
Call createUploadLink to retrieve a pre-signed URL for the file upload.
Call uploadFile to upload the file to that URL. This function requires the browser File API and cannot run in a server action.
Call createImportJob with the fileKey returned by uploadFile to begin the import job.
File Formats
The fileFormat parameter accepts the following values:
Value
Label
Description
CSV
A single comma-separated values file.
ZIPWITHCSV
ZIP CSV
A ZIP archive containing a CSV file.
JSON
JSON Lines
A single file with one JSON object per line.
ZIPWITHJSON
ZIP JSON Lines
A ZIP archive containing a JSON Lines file.
ZIPWITHMULTIPLEJSON
ZIP with Multiple JSON Files
A ZIP archive containing one JSON file per record.
Changelog
Date
Change
2026-09-01
Initial publication.
APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.
The UI (user interface) is a device's end-user interaction and communication point. It can include display screens, keyboards, and mouse. It is also how a user interacts with your application.
An API endpoint is the location where an API receives requests for a specific resource on its server. It's the point of contact between an API client and an API server, and is usually a uniform resource locator (URL) that provides the location of the resource.
Pagination is the process of separating content into individual pages.
An API endpoint is the location where an API receives requests for a specific resource on its server. It's the point of contact between an API client and an API server, and is usually a uniform resource locator (URL) that provides the location of the resource.
The HTTP POST method is used to send data to a server to create or update a resource, typically including the data in the body of the request.
A URL (uniform resource locator) is a unique identifier used to locate a resource on the internet. Also known as a web address.
APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.
Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.
A zip file is a file format that can contain multiple files combined and compressed into one file. Since it's a type of compressed file, a zip file can be smaller in size than the files it contains.
JSON Lines is a format for storing structured data that may be processed one record at a time. It works with unix-style text processing tools and shell pipelines.
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.
JSON (JavaScript Object Notation) is an open standard file and data interchange format. Unqork uses JSON for submission (record) data.