Get Records

GET

apps

{app_id}

collections

{collection_id}

records

curl --request GET \
  --url https://api.withcortex.ai/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"
  }
]

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

Available options:

all

Example:

["all"]

string

status

enum<string>

Available options:

ALL,

DRAFT,

QUEUED,

RUNNING,

CANCELLED,

COMPLETED,

FAILED

Response

200 - application/json

string

required

Unique identifier for the record

name

string | null

required

Name of the record

Example:

"Important Record"

status

enum<string>

required

Current status of the record

Available options:

DRAFT,

QUEUED,

RUNNING,

CANCELLED,

COMPLETED,

FAILED

Example:

"COMPLETED"

source

enum<string>

required

Source from which the record was created

Available options:

APP,

API,

TRIGGER

Example:

"API"

rules_count

number

required

Total number of rules of this record

rules_pass_count

number

required

Number of passed rules

rules_fail_count

number

required

Number of failed rules

rules_warn_count

number

required

Number of rules with warnings

rules

object

required

Rules associated with this record

rules.{key}

object

Detailed information about a record rule

rules.{key}.status

enum<string>

required

Current status of the record rule

Available options:

DRAFT,

RUNNING,

PASSED,

FAILED,

WARN

Example:

"PASSED"

rules.{key}.key

string

required

Unique key of the rule within the collection

Example:

"CHECK_BUSINESS_NAME"

rules.{key}.input

object | null

required

Input values used for the rule execution

Example:

{ "business_name": "Acme Corp" }

rules.{key}.run

object | null

required

Details of the rule execution workflow run

rules.{key}.run.id

string

required

Unique identifier for the run

rules.{key}.run.input

object | null

required

Input values used for the run

rules.{key}.run.output

object

required

Output of the run

rules.{key}.run.status

enum<string>

required

Status of the run

Available options:

PENDING,

RUNNING,

CANCELLED,

COMPLETED,

SKIPPED,

FAILED

Example:

"RUNNING"

rules.{key}.run.origin

enum<string>

required

Origin of the run

Available options:

WORKFLOW,

TRIGGER,

RECORD,

TEST,

ENDPOINT

Example:

"WORKFLOW"

rules.{key}.run.started_at

string | null

required

Timestamp of when the run started

rules.{key}.run.ended_at

string | null

required

Timestamp of when the run ended

rules.{key}.run.app_id

string

required

ID of the associated app where the run was triggered from

rules.{key}.run.workflow_app_id

string

required

ID of the associated app where the workflow belongs to

rules.{key}.run.workflow_id

string

required

ID of the associated workflow

rules.{key}.run.workflow_version_draft

object | null

required

Draft version of the workflow

rules.{key}.run.workflow_version

object | null

required

Details of the workflow version used for the run

rules.{key}.run.created_at

string | null

required

Timestamp of when the run was created

rules.{key}.run.updated_at

string | null

required

Timestamp of when the run was last updated

rules.{key}.run.result

any | null

Result of the run

rules.{key}.run.error

string

Error message if the run failed

rules.{key}.run.collection_id

string

ID of the associated collection

rules.{key}.run.record_id

string

ID of the associated record

rules.{key}.run.version

number

Version number of the workflow

rules.{key}.run.usage

object

Credits usage of the run

rules.{key}.created_at

string | null

required

Timestamp when the record rule was created

rules.{key}.updated_at

string | null

required

Timestamp when the record rule was last updated

rules.{key}.verbose

enum<string>[]

Available options:

all

rules.{key}.result

any | null

Result of the rule execution

rules.{key}.error

string

Error message if the rule execution failed

Example:

"Invalid input data"

config

object

required

Configuration of the collection this record belongs to

config.id

string

required

Unique identifier for the collection configuration

config.rules

object[]

required

List of rules associated with the collection

Detailed information about a rule

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 | null

Default config input values to execute the workflow with

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

Mapping of a source field to multiple destination fields

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 | null

required

Timestamp when the configuration was created

config.updated_at

string | null

required

Timestamp when the configuration was last updated

collection_name

string

required

Name of the collection this record belongs to

collection_id

string

required

Unique identifier of the collection this record belongs to

Example:

"col_xxx"

created_by

object

required

User who created this record

Example:

{ "id": "user_xxx", "name": "John Doe" }

entity

object | null

required

Entity associated with this record

tags

object[]

required

Tags associated with this record

Detailed information about an app tag (which can be attached to records, workflows, etc.)

created_at

string | null

required

Timestamp when the record was created

updated_at

string | null

required

Timestamp when the record was last updated

usage

object

Credit usage information of the record

Was this page helpful?

Raise issue

Update a Collection Create a Record

curl --request GET \
  --url https://api.withcortex.ai/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"
  }
]

API Reference

Collections

Records

Workflows

Tests

Variables

Files

Webhooks

Path Parameters

Query Parameters

Response