List Package Configs

List matching package configs for your organization with cursor-based pagination, newest first by default.

List the matching package configs that belong to your organization. Results are cursor-paginated and ordered newest first by default. Each entry is the same shape returned when the config was created, including its document-type slots, pass criteria, and resource links.

Pagination is cursor-based. The response carries a pagination block with total, limit, has_more, and next_cursor. To fetch the next page, pass the next_cursor value back as the cursor query parameter. When has_more is false, you have reached the last page.

Use this endpoint to enumerate the package configs available before triggering a run, or to drive a selection UI. Every config is tenant-scoped, so you only ever see configs created under your own organization.

GET/v1/matching/packages/configs

Response

Response fields

dataarrayArray of package config objects.

data[].idstringPackage config UUID.

data[].namestringPackage config name.

data[].document_type_configsarrayDocument-type slots.

data[].pass_criteriaobjectPass/fail aggregation rules.

data[].created_atstringISO 8601 creation timestamp.

data[].updated_atstringISO 8601 last-update timestamp.

data[].linksobjectRelated resource URLs (self, runs).

pagination.totalintegerTotal number of configs matching the query.

pagination.limitintegerMaximum results per page.

pagination.has_morebooleanWhether more results exist beyond this page.

pagination.next_cursorstring | nullCursor to fetch the next page. Null if no more results.

Response

{
  "data": [
    {
      "id": "pkg_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Shipment bundle",
      "document_type_configs": [
        { "document_type": "invoice", "matching_config_id": "mc_uuid_1", "presence": "required" },
        { "document_type": "delivery_note", "matching_config_id": "mc_uuid_2", "presence": "expected" }
      ],
      "pass_criteria": {
        "all_required_matched": true,
        "min_confidence": 0.8,
        "allow_review_on_expected": true
      },
      "created_at": "2024-09-14T10:32:00.000Z",
      "updated_at": "2024-09-14T10:32:00.000Z",
      "links": {
        "self": "/v1/matching/packages/configs/pkg_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "runs": "/v1/matching/packages/runs?package_config_id=pkg_a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    }
  ],
  "pagination": {
    "total": 3,
    "limit": 20,
    "has_more": false,
    "next_cursor": null
  }
}

The default ordering is newest first. Pass order=asc to walk configs oldest-first, which is convenient when you want a stable cursor over a config set that is still growing.

Errors

Error responses

401unauthorizedMissing or invalid API key.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Get Package Config

Create Package Config