Scope

Trigger a new catalogue scope run.

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.

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)

Headers

Authorizationstring required

Bearer <api-key> or Bearer <access-token>.

Idempotency-Keystring

Client-generated key (UUID recommended). The server returns the same 202 response for duplicate requests with the same key within the idempotency window.

Response

Run accepted and queued.

runIdstring
status'queued'

Changes

No recorded changes to this operation across all 1 revision of this API.