Collections
Records
Workflows
- GETDiscover Workflows
- GETGet Discoverable Workflow
- GETGet Discoverable Workflow Version
- POSTRun Discoverable Workflow
- POSTCancel a Discoverable Workflow Run
- GETGet Workflows
- GETGet a Workflow
- GETGet Workflow Runs
- POSTRun a Workflow
- GETGet a Workflow Run
- POSTReplay a Workflow Run
- POSTCancel a Workflow Run
- PATCHUpdate Run Data Retention Configuration
- GETGet Workflow Versions
- GETGet a Workflow Version
Tests
Variables
Files
Collections
Get Collections
Get a list of all collections of your app.
GET
/
apps
/
{app_id}
/
collections
[
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"config": {
"id": "<string>",
"rules": [
{
"name": "Check Business Name",
"key": "CHECK_BUSINESS_NAME",
"execution_order": "before-all",
"on_success": "PASS",
"on_fail": "WARN",
"step_key": "<string>",
"workflow_id": "work_xxx",
"workflow_version_id": "workv_xxx",
"workflow_use_latest": true,
"workflow_input_default": {
"business_name": "Example Corp"
},
"disabled": false
}
],
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"records_count": 123,
"deleted": true,
"triggers": [
{
"id": "<string>",
"type": "ENCOMPASS",
"name": "My Encompass Trigger",
"config": {
"type": "ENCOMPASS",
"mappings": [
{
"type": "document",
"name": "<string>",
"entity_path": "<string>",
"input_path": [
"<string>"
]
}
],
"pull_on_millestones": [
"Application Received",
"Underwriting Complete",
"Clear to Close"
],
"pull_on_folders": [
"Loan Folder",
"Document Folder",
"Underwriting Folder"
]
},
"enabled": true,
"connection_id": "con_xxx",
"collection_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>"
}
]
Path Parameters
The ID of the app
Query Parameters
What you want to search for in collections
Tags to filter collections by (you can use up to 20)
Example:
["tag_xxx", "tag_yyy"]
Page number
Number of items to take
Next page token (Only used on special endpoints)
Response
200 - application/json
You'll receive an array of collections.
The response is of type object[]
.
Was this page helpful?
[
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"app": {
"id": "<string>",
"name": "<string>",
"verified": true
},
"config": {
"id": "<string>",
"rules": [
{
"name": "Check Business Name",
"key": "CHECK_BUSINESS_NAME",
"execution_order": "before-all",
"on_success": "PASS",
"on_fail": "WARN",
"step_key": "<string>",
"workflow_id": "work_xxx",
"workflow_version_id": "workv_xxx",
"workflow_use_latest": true,
"workflow_input_default": {
"business_name": "Example Corp"
},
"disabled": false
}
],
"mappings": [
{
"source_path": "LOAN_APPLICATION:income",
"destination_paths": [
"MONTHLY_INCOME:amount",
"ANNUAL_INCOME:amount"
]
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
},
"tags": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"app_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"records_count": 123,
"deleted": true,
"triggers": [
{
"id": "<string>",
"type": "ENCOMPASS",
"name": "My Encompass Trigger",
"config": {
"type": "ENCOMPASS",
"mappings": [
{
"type": "document",
"name": "<string>",
"entity_path": "<string>",
"input_path": [
"<string>"
]
}
],
"pull_on_millestones": [
"Application Received",
"Underwriting Complete",
"Clear to Close"
],
"pull_on_folders": [
"Loan Folder",
"Document Folder",
"Underwriting Folder"
]
},
"enabled": true,
"connection_id": "con_xxx",
"collection_id": "<string>",
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>"
}
]