Skip to main content

List Configs

List all matching configurations for the current workspace. Each config defines field mappings, strategies, and weights used to match documents against reference data.

Matching connects incoming documents to reference datasets using configurable field-level strategies. Each configuration defines which fields to compare, how to compare them (exact, fuzzy, date range, numeric range), and the relative weight of each field in the overall confidence score.

GET/v1/matching/configs

Response

Response fields

dataarrayArray of matching configuration objects.
data[].idstringConfiguration UUID.
data[].namestringHuman-readable config name.
data[].reference_data_idstringID of the reference dataset this config matches against.
data[].target_typestringTargeting mode (e.g. "run").
data[].target_valueobjectTarget-specific configuration values.
data[].field_mappingsarrayArray of field mapping objects (source, target, strategy, weight).
data[].thresholdnumberMinimum confidence score to consider a match (0–1).
data[].created_atstringISO 8601 creation timestamp.
data[].updated_atstringISO 8601 last update timestamp.
data[].links.selfstringURL to this config.
data[].links.runsstringURL to trigger a run for this config.
pagination.totalintegerTotal number of configs.
pagination.limitintegerMaximum results per page.
pagination.has_morebooleanWhether more results exist beyond this page.
pagination.next_cursorstring | nullCursor to fetch the next page.

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Vendor Invoice Match",
      "reference_data_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "target_type": "run",
      "target_value": {},
      "field_mappings": [
        { "source": "vendor_name", "target": "name", "strategy": "fuzzy", "weight": 0.4 },
        { "source": "invoice_date", "target": "date", "strategy": "date_range", "weight": 0.3 },
        { "source": "amount", "target": "total", "strategy": "numeric_range", "weight": 0.3 }
      ],
      "threshold": 0.85,
      "created_at": "2024-10-01T08:00:00.000Z",
      "updated_at": "2024-10-01T08:00:00.000Z",
      "links": {
        "self": "/v1/matching/configs/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "runs": "/v1/matching/configs/a1b2c3d4-e5f6-7890-abcd-ef1234567890/run"
      }
    }
  ],
  "pagination": {
    "total": 2,
    "limit": 20,
    "has_more": false,
    "next_cursor": null
  }
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Create Config
Run Matching