List Package Runs

List matching package runs for your organization, filterable by package config and status. Each run carries its verdict and per-type document results.

List the matching package runs that belong to your organization. Results are cursor-paginated and ordered newest first by default. Each entry is the full run shape, including its aggregated status, per-type document results, and the document ids that were supplied.

You can narrow the list with two filters. Pass package_config_id to return only runs of a specific config, and pass status to return only runs with a given verdict, such as passed or review. Combine both to find, for example, every failing run of one package config.

Pagination follows the same cursor pattern used across the API. The pagination block carries total, limit (1–100, default 20), has_more, and next_cursor. Pass next_cursor back as the cursor query parameter to page forward; filters stay applied across pages. Every run is tenant-scoped to your organization.

This list is also the read path for individual runs: the public API exposes no separate GET-by-id route for package runs, so to re-read one, filter the list (by package_config_id, and by status if useful) and pick the run out by its id. Runs are immutable once terminal, which makes the list safe to mirror into your own audit store — a page you exported never changes retroactively.

curl -s "https://api.talonic.com/v1/matching/packages/runs?package_config_id=4f2a9c1e-8b3d-47e6-9a05-c7d1e2f3a4b5&status=review" \
  -H "Authorization: Bearer tlnc_your_api_key"

Response

{
  "data": [
    {
      "id": "8d7e6f50-4c3b-42a1-b0e9-d8c7b6a59483",
      "package_config_id": "4f2a9c1e-8b3d-47e6-9a05-c7d1e2f3a4b5",
      "status": "passed",
      "document_results": [
        {
          "document_type": "invoice",
          "matching_config_id": "1a2b3c4d-5e6f-4781-92a3-b4c5d6e7f809",
          "matching_run_id": null,
          "presence": "required",
          "document_found": true,
          "status": "matched",
          "confidence": 0.93
        }
      ],
      "input_documents": { "invoice": ["b8b00d51-eecc-49b3-affc-89fee95b9518"] },
      "error": null,
      "created_at": "2024-09-14T10:40:00.000Z",
      "completed_at": "2024-09-14T10:40:03.000Z",
      "links": {
        "self": "/v1/matching/packages/runs/8d7e6f50-4c3b-42a1-b0e9-d8c7b6a59483",
        "config": "/v1/matching/packages/configs/4f2a9c1e-8b3d-47e6-9a05-c7d1e2f3a4b5"
      }
    }
  ],
  "pagination": {
    "total": 12,
    "limit": 20,
    "has_more": false,
    "next_cursor": null
  }
}

Errors