---
title: "Trigger a new catalogue scope run."
method: POST
path: "/api/v1/scope/catalogue/runs"
tags: ["Scope"]
---

# Trigger a new catalogue scope run.

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

## Request

- Base URL: `https://app.tracepass.eu`
- URL: `https://app.tracepass.eu/api/v1/scope/catalogue/runs`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.tracepass.eu/api/oauth/authorize`, token URL `https://app.tracepass.eu/api/oauth/token`, scopes: `passports:read`)

Enqueues a full re-evaluation of every passport in the company's
catalogue against the current scope rules. Returns 202 immediately
with a `runId`; poll `GET /api/v1/scope/catalogue/runs/{id}` for
status. Once `status` is `done`, the updated results are available
via `GET /api/v1/scope/catalogue`.

Idempotent within a short window: supply the same
`Idempotency-Key` header to avoid double-triggering a run. A
409 is returned if a run is already in progress for this
company. A 429 with `error: run_cooldown` is returned when a
run completed too recently.

Auth: Bearer API key OR OAuth with `passports:read`. Requires
the Growth plan or higher.

## Headers

- `Authorization` string, required
- `Idempotency-Key` string

## Response `202`

Run accepted and queued.

- object
  - `runId` string
  - `status` 'queued'

## Other responses

- `401`: Missing or invalid API key.
- `403`: Plan upgrade required. The catalogue scope check is available from the Growth plan.
- `409`: A catalogue run is already queued or running for this company.
- `429`: Run cooldown: a run completed too recently. `Retry-After` header gives the seconds until the cooldown expires.

---

[API](https://skmtc.dev/tracepass/apis/tracepass-api.md) · [All operations](https://skmtc.dev/tracepass/apis/tracepass-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tracepass/apis/tracepass-api/revisions/60ddeb25638b?raw)