Scope

Get the catalogue scope report.

Returns the most recent catalogue scope run results: for each passport/product pair evaluated, whether it is in scope, the applicable regulation article, and whether the scope status changed since the last run.

Paginated via cursor. Each page counts as one v1 passport read against the daily cap.

Auth: Bearer API key OR OAuth with passports:read. Requires the Growth plan or higher (scopeCatalogueEnabled); returns 403 with error: plan_upgrade_required when the plan gate is not met.

get/api/v1/scope/catalogue

Request

  • Base URL: https://app.tracepass.eu
  • URL: https://app.tracepass.eu/api/v1/scope/catalogue
  • 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)

Query parameters

classification'missing' | 'draft_only' | 'published_incomplete' | 'published' | 'not_required' | 'open_questions' | 'not_covered'

Filter results by passport classification.

categorystring

Filter results by product category key.

changedboolean

When true, return only passports whose scope status changed.

cursorstring

Opaque pagination cursor from the previous page's nextCursor.

limitinteger

Number of items per page (1–100, default 20).

Headers

Authorizationstring required

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

Response

Catalogue scope report page.

nextCursorstring nullable required

Opaque pagination cursor for the next page; null on the last page.

disclaimerstring required

Changes

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