GET
/
apps
/
{app_id}
/
collections
/
{collection_id}
/
records
[
  {
    "id": "<string>",
    "name": "Important Record",
    "status": "COMPLETED",
    "source": "API",
    "usage": {
      "total": 123,
      "calls": [
        {
          "id": "<string>",
          "total": 123,
          "calls": [
            {}
          ]
        }
      ],
      "rules": {}
    },
    "rules_count": 123,
    "rules_pass_count": 123,
    "rules_fail_count": 123,
    "rules_warn_count": 123,
    "rules": {},
    "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"
    },
    "collection_name": "<string>",
    "collection_id": "col_xxx",
    "created_by": {
      "id": "user_xxx",
      "name": "John Doe"
    },
    "entity": {
      "id": "<string>",
      "entity_id": "<string>",
      "status": "SYNCED",
      "type": "ENCOMPASS",
      "trigger_id": "<string>",
      "record_id": "<string>",
      "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"
      }
    ],
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25",
    "link": "<string>"
  }
]

Path Parameters

app_id
string
required

The ID of the app

collection_id
string
required

The ID of the collection

Query Parameters

verbose
enum<string>[]

Properties to include in the record response

Example:
["all"]
status
enum<string>
Available options:
ALL,
DRAFT,
QUEUED,
RUNNING,
CANCELLED,
COMPLETED,
FAILED
tags
string[]
tag_ids
string[]
page
number

Page number

take
number

Number of items to take

next
string

Next page token (Only used on special endpoints)

Response

200 - application/json

The response is of type object[].