---
title: Start a catalogue run
description: Trigger a fresh catalogue scope run — re-evaluates every product. Growth and up. Idempotency-Key supported. Poll with GET runs/{id}.
canonical: "https://www.tracepass.eu/docs/start-catalogue-run"
locale: en
source: "https://www.tracepass.eu/docs/start-catalogue-run"
---

# Start a catalogue run

> Trigger a fresh catalogue scope run — re-evaluates every product. Growth and up. Idempotency-Key supported. Poll with GET runs/{id}.

```http
POST /api/v1/scope/catalogue/runs
```

Triggers a fresh catalogue scope run that re-checks the whole catalogue against the current rules. The run queues immediately and executes asynchronously; the response is 202 with a `runId` to poll. The catalogue also refreshes nightly automatically.

Requires Growth or higher. Idempotency-Key is honoured: reuse the same key within 24 hours to get the original run back without queueing a second one. 409 `run_in_progress` when a run for this company is already queued or running (the running `runId` is in the body). 429 `run_cooldown` with `retryAfter` if a run finished less than 10 minutes ago.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Authorization` | header | string | yes | `Bearer <token>` — either a `tp_` API key (Developer → API Keys; simplest, for server-to-server) or an OAuth 2.0 access token (Developer → OAuth Apps; for user-authorized apps, scoped + revocable). The Authentication page has the full OAuth flow and scope list. |
| `Idempotency-Key` | header | string | no | UUID v4 per logical run request. Reuse within 24 hours to get the same run back. |

## Examples

```bash
curl -sS -X POST https://app.tracepass.eu/api/v1/scope/catalogue/runs \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" \
  -H "Idempotency-Key: 7b4f1e2c-9a3d-4e5b-8c1a-2d3e4f5a6b7c"
```

```typescript
import { randomUUID } from "node:crypto";
const res = await fetch("https://app.tracepass.eu/api/v1/scope/catalogue/runs", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TRACEPASS_API_KEY}`,
    "Idempotency-Key": randomUUID(),
  },
});
const { runId, status } = await res.json();
// Poll GET /api/v1/scope/catalogue/runs/{runId} until status === "done"
```

```python
import os, uuid, requests
resp = requests.post(
    "https://app.tracepass.eu/api/v1/scope/catalogue/runs",
    headers={
        "Authorization": f"Bearer {os.environ['TRACEPASS_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
run = resp.json()  # { runId, status }
```

## Responses

### 202 — Run queued

```json
{ "runId": "6acbb533c5553f06d833479e", "status": "queued" }
```

### 409 — Run already in progress

```json
{ "error": "run_in_progress", "message": "A catalogue run is already queued or running.", "runId": "6acbb533c5553f06d833479e", "run": null }
```

### 429 — Run cooldown

```json
{ "error": "run_cooldown", "message": "A catalogue run finished a few minutes ago. Try again shortly.", "retryAfter": 600, "run": { "id": "6acbb533c5553f06d833479e", "trigger": "manual", "status": "done", "rulesFingerprint": "86a23cce6480bffb91d360b7a199b473", "counts": { "evaluated": 1, "distinctFactSets": 1, "changed": 1, "removed": 0, "answersChanged": 0 }, "createdAt": "2026-10-11T16:11:31.583Z", "startedAt": "2026-10-11T16:11:31.588Z", "finishedAt": "2026-10-11T16:11:31.619Z", "error": null } }
```

### 403 — Plan upgrade required

```json
{ "error": "plan_upgrade_required", "feature": "scopeCatalogueEnabled", "message": "The catalogue scope check is available from the Growth plan." }
```

## Related

- [GET Run status](https://www.tracepass.eu/docs/get-catalogue-run.md)
- [GET Catalogue report](https://www.tracepass.eu/docs/scope-catalogue.md)