Get Collections

GET

apps

{app_id}

collections

Get Collections

curl --request GET \
  --url https://api.example.com/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",
          "on_success": "PASS",
          "on_fail": "WARN",
          "workflow_id": "work_xxx",
          "workflow_version_id": "workv_xxx",
          "workflow_use_latest": true,
          "execution_order": "before-all",
          "step_key": "<string>",
          "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",
              "entity_path": "<string>",
              "input_path": [
                "<string>"
              ],
              "name": "<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

app_id

string

required

The ID of the app

Query Parameters

string

What you want to search for in collections

Response

200 - application/json

You'll receive an array of collections.

string

required

Unique identifier for the collection

name

string

required

Name of the collection

description

string | null

required

Description of the collection

app

object

required

Public information about an app (organization)

Show child attributes

app.id

string

required

Unique identifier for the app

app.name

string

required

Name of the app

app.verified

boolean

required

Verification status of the app

config

object

required

Configuration of the collection. Including rules, triggers, etc.

Show child attributes

config.id

string

required

Unique identifier for the collection configuration

config.rules

object[]

required

List of rules associated with the collection

Show child attributes

config.rules.name

string

required

Name of the rule

Example:

"Check Business Name"

config.rules.key

string

required

Unique key of the rule within the collection

Example:

"CHECK_BUSINESS_NAME"

config.rules.on_success

enum<string>

required

Action to take if the rule passes

Available options:

PASS,

FAIL,

WARN

Example:

"PASS"

config.rules.on_fail

enum<string>

required

Action to take if the rule fails

Available options:

PASS,

FAIL,

WARN

Example:

"WARN"

config.rules.workflow_id

string

required

Unique identifier of the linked workflow

Example:

"work_xxx"

config.rules.workflow_version_id

string

required

Unique identifier of the specific workflow version to use

Example:

"workv_xxx"

config.rules.workflow_use_latest

boolean

required

Should the rule use the latest version of the workflow?

Example:

true

config.rules.execution_order

string

When to run this rule compared to others

Example:

"before-all"

config.rules.step_key

string | null

Step key to run the rule on

config.rules.workflow_input_default

object

Default config input values to execute the workflow with

Show child attributes

config.rules.workflow_input_default.{key}

unknown

Example:

{ "business_name": "Example Corp" }

config.rules.disabled

boolean

Whether the rule is disabled

Example:

false

config.mappings

object[]

required

List of input field mappings of the collection

Show child attributes

config.mappings.source_path

string

required

Path to the source input field

Example:

"LOAN_APPLICATION:income"

config.mappings.destination_paths

string[]

required

Paths to the destination input fields to map to

Example:

[
  "MONTHLY_INCOME:amount",
  "ANNUAL_INCOME:amount"
]

config.created_at

string<date> | null

required

Timestamp when the configuration was created

config.updated_at

string<date> | null

required

Timestamp when the configuration was last updated

tags

object[]

required

Tags attached to this collection

Show child attributes

tags.id

string

required

Unique identifier for the tag

tags.name

string

required

Name of the tag

tags.color

string | null

required

Color associated with the tag

tags.app_id

string

required

Identifier for the associated app

tags.created_at

string<date> | null

required

Timestamp when the tag was created

tags.updated_at

string<date> | null

required

Timestamp when the tag was last updated

records_count

number

required

How many records are in the collection

deleted

boolean

required

Has the collection been deleted

triggers

object[]

required

Triggers associated with the collection

Show child attributes

triggers.id

string

required

Unique identifier for the trigger

triggers.type

enum<string>

required

Service that the trigger is connected to

Available options:

ENCOMPASS,

PERSONA

Example:

"ENCOMPASS"

triggers.name

string | null

required

Name of the trigger

Example:

"My Encompass Trigger"

triggers.config

object

required

Configuration of the trigger

Option 1
Option 2

Show child attributes

triggers.config.type

enum<string>

required

Type of the trigger connection

Available options:

ENCOMPASS

triggers.config.mappings

object[]

Mappings of the trigger

Maximum array length: 512

Detailed information about a trigger mapping

Option 1
Option 2

Show child attributes

triggers.config.mappings.type

enum<string>

required

Available options:

document

triggers.config.mappings.entity_path

string

required

triggers.config.mappings.input_path

string[]

required

Maximum array length: 512

triggers.config.mappings.name

string

triggers.config.pull_on_millestones

string[]

Milestones to pull from Encompass

Maximum array length: 5

Maximum string length: 512

Example:

[
  "Application Received",
  "Underwriting Complete",
  "Clear to Close"
]

triggers.config.pull_on_folders

string[]

Folders to pull from Encompass

Maximum array length: 5

Maximum string length: 512

Example:

[
  "Loan Folder",
  "Document Folder",
  "Underwriting Folder"
]

triggers.enabled

boolean

required

Whether the trigger is enabled or not

triggers.connection_id

string | null

required

Unique identifier of the connected service

Example:

"con_xxx"

triggers.collection_id

string

required

Unique identifier of the collection this trigger belongs to

triggers.created_at

string<date> | null

required

Creation date of the trigger

triggers.updated_at

string<date> | null

required

Last update date of the trigger

created_at

string<date> | null

required

Timestamp when the collection was created

updated_at

string<date> | null

required

Timestamp when the collection was last updated

link

string

required

Link to the collection in the UI

Create a CollectionCreate a new collection for your app.

⌘I

Get Collections

curl --request GET \
  --url https://api.example.com/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",
          "on_success": "PASS",
          "on_fail": "WARN",
          "workflow_id": "work_xxx",
          "workflow_version_id": "workv_xxx",
          "workflow_use_latest": true,
          "execution_order": "before-all",
          "step_key": "<string>",
          "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",
              "entity_path": "<string>",
              "input_path": [
                "<string>"
              ],
              "name": "<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>"
  }
]

Getting Started

Collections

Records

Workflows

Tests

Variables

Files

Webhooks

Get Collections

Path Parameters

Query Parameters

Response