Unqork's customer-facing REST API, based on open standards, for setting and retrieving module submission data and controlling other aspects of an Unqork environment. 93 operations across Submissions, Applications, Workflow, Modules, Promotions, Users, Groups, Transforms, Global Variables, Credentials, Revisions, Data Collections, Data Model Records, Search Configs, Logs and Query. All communication is over HTTPS with JSON responses; every request is authorized with an OAuth 2.0 bearer token.
This API exposes
93 operations
across 64 paths,
organized into 16 resource areas,
and defines 59 schemas.
It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://{host}/api/1.0.
93 operations64 paths59 schemas11 DELETE38 GET2 PATCH29 POST13 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://training.unqork.io/api/1.0
Authentication
OAuth 2.0
Resource Areas
16
Authentication & Security 1
Unqork Customer API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the clientCredentials and password flows, exposing 1 scope.
By default, every request must be authenticated.
OAuth2 — The Unqork API implements the [OAuth 2.0 Client Credentials Grant](https://datatracker.ietf.org/doc/html/rfc6749section-1.3.4) and the [OAuth 2.0 Password Gran…
Paths & Operations 93
Across 64 paths, the API surfaces 93 operations — 11 DELETE, 38 GET, 2 PATCH, 29 POST, 13 PUT. They span 16 resource areas, including Authentication, Submissions, Revisions, Workflow, Users, Groups, Transforms, Modules, and 8 more. Each is listed below with its method, path, parameters, and response codes.
Authentication 1
POST
/referstring
Generates an encrypted referstring for authentication
The following endpoints are available to "Administrator" users only.
GET
/users
Get Users
getUsers4 params→ 200default
POST
/users
Create User
createUser2 paramsbody→ 201default
GET
/users/{userId}
Get User
getUser1 param→ 200default
PUT
/users/{userId}
Update User
updateUser2 paramsbody→ 200default
DELETE
/users/{userId}
Delete User
deleteUser1 param→ 204default
GET
/users/{userId}/passwordStatus
Get User Password Status
getUserPasswordStatus1 param→ 200default
Groups 5
The following endpoints are available to "Administrator" users only.
GET
/groups
Get Groups
getGroups1 param→ 200default
POST
/groups
Create Group
createGroupbody→ 201default
GET
/groups/{groupName}
Get Group
getGroup1 param→ 200default
PUT
/groups/{groupName}
Update Group
updateGroup1 parambody→ 200default
DELETE
/groups/{groupName}
Delete Group
deleteGroup1 param→ 204default
Transforms 5
The following endpoints are available to "Administrator" users only. Transforms should expect the following input data structure: NJK (in): Input includes only the data.rawData pa…
GET
/modules/{moduleId}/transforms
Get Transforms
getTransforms2 params→ 200default
POST
/modules/{moduleId}/transforms
Create Transform
createTransform1 parambody→ 201default
GET
/modules/{moduleId}/transforms/{transformName}
Get Transform
getTransform2 params→ 200default
PUT
/modules/{moduleId}/transforms/{transformName}
Update Transform
updateTransform2 paramsbody→ 200default
DELETE
/modules/{moduleId}/transforms/{transformName}
Delete Transform
deleteTransform2 params→ 204default
Modules 9
GET
/modules
Get Modules
getModules1 param→ 200default
GET
/modules/{moduleId}
Get Module
getModule1 param→ 200default
POST
/modules/{moduleId}/restore
Restore a Deleted Module
restoreDeletedModule1 parambody→ 204422default
PUT
/modules/{moduleId}/execute
Execute Module
executeModule1 parambody→ 2004122XX4XX5XXdefault
GET
/modules/{moduleId}/api
Execute via Proxy - GET
apiProxySSEGet1 param→ 2004122XX4XX5XXdefault
POST
/modules/{moduleId}/api
Execute via Proxy - POST
apiProxySSEPost1 param→ 2004122XX4XX5XXdefault
PUT
/modules/{moduleId}/api
Execute via Proxy - PUT
apiProxySSEPut1 param→ 2004122XX4XX5XXdefault
PATCH
/modules/{moduleId}/api
Execute via Proxy - PATCH
apiProxySSEPatch1 param→ 2004122XX4XX5XXdefault
DELETE
/modules/{moduleId}/api
Execute via Proxy - DELETE
apiProxySSEDelete1 param→ 2004122XX4XX5XXdefault
Data Collections 2
GET
/modules/{moduleId}/accessibleDataCollections
Get Module Accessible Data Collections
getDataCollectionList1 param→ 200default
POST
/dataCollections/{collection}/import
Update Data Collection via Import
importDataCollection1 parambody→ 200default
Promotions 7
The following endpoints are available to "Administrator" users and users with the "Promote" permission for the resource.
GET
/promote/hosts
Promotion Hosts
getPromotionHosts→ 200default
POST
/promote/module
Promote Module
promoteModulebody→ 204default
POST
/promote/referenceData
Promote Reference Data
promoteDataCollectionbody→ 204default
POST
/promote/applicationByItems
Promote Application by items
promoteApplicationByItemsbody→ 200default
POST
/promote/style
Promote Style
promoteStylebody→ 204default
POST
/promote/groups
Promote Groups
promoteGroupsbody→ 204default
POST
/promote/roles
Promote Roles
promoteRolesbody→ 204default
Global Variables 5
GET
/globalvars
Get Global Variables
promoteGlobalVariables→ 200default
POST
/globalvars
Create Global Variables
createGlobalVariablebody→ 201default
GET
/globalvars/{globalVariableId}
Get Global Variable
getGlobalVariable1 param→ 200default
PATCH
/globalvars/{globalVariableId}
Update Global Variable
updateGlobalVariable1 parambody→ 200default
DELETE
/globalvars/{globalVariableId}
Delete Global Variable
deleteGlobalVariable1 param→ 204default
Applications 15
An application is the parent of a group of one or more elements. An application can be of either 'Module' (type is form in DB) or 'Workflow' type. 'Module' type application cannot…
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are UserResponse (13 properties), ApplicationResponse (13 properties), PromotionApplicationByItemExecuteRequest (12 properties), UserPut (11 properties). Each schema is shown below with its type and property counts.
List of timer start nodes and their statuses in a particular workflow
3 properties
RetrievedTimedEventsBySubmissionIdResponse
array
List of timed event actions and their statuses in a particular workflow submission
DataCollectionImportExecuteResponse
object
1 property
Error
object
Error
2 properties2 required
FailedExecuteResponse
object
3 properties
PromotionGroupExecuteRequest
object
3 properties2 required
PromotionRoleExecuteRequest
object
2 properties2 required
PromotionModuleExecuteRequest
object
3 properties3 required
PromotionApplicationByItemExecuteRequest
object
12 properties3 required
PromotionReferenceDataExecuteRequest
object
3 properties3 required
PromotionStyleExecuteRequest
object
3 properties3 required
PromotionHosts
array
GlobalVariable
object
10 properties
GlobalVariablePost
object
4 properties1 required
GlobalVariablePatch
object
4 properties
MetadataRequest
object
Object containing key-value pairs. To set nested values, this must be an object like {"statuses.complete": "yes", "statuses.processed": "no"}, which is MongoDB…
DataFilter
object
Filter condition against submission "data" field. Value must be a MongoDB query condition (see Examples, below). NOTE: MongoDB selectors that can be nested ins…
MetadataFilter
object
Filter condition against submission "metadata" field. Value must be a MongoDB query condition (see Examples, below). MongoDB [dot notation](https://docs.mongod…
ValidationErrors
array
ExecutionError
object
5 properties
InvalidNavigationPanels
array
ListAuditLogsResponse
object
1 property
CredentialResponse
object
11 properties7 required
CredentialRequest
object
6 properties3 required
ArrayOfModelRecords
array
ModelRecord
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Unqork Customer API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
