Skip to main content
GET
List PACT v3 footprints
This serves locked PCF declarations shared to the API, as PACT v3 product footprints. A footprint’s id is its PCF’s id. A PCF that a newer locked version replaced reads status: "Deprecated"; the newer footprint lists it in precedingPfIds.

Filters

The query parameters are the PACT v3 filters. Repeat a parameter to match any of its values; different parameters must all match. An empty parameter filters nothing. A footprint is valid from its declared validity start, or else the end of its reference period, until its declared validity end, or else three years after the reference period ends.

Paging

Pass limit for the page size. A page holds at most 100 footprints, whatever the limit, and can hold fewer than the limit when a footprint fails the PACT v3 schema and is left out. Follow the Link header, not the page size: its next URL carries your filters, so request it until there is none.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

productId
string[]

A product's id, as urn:uuid:<id> or the bare id. Matches the PCFs of that product.

companyId
string[]

Your company's id, as urn:uuid:<id> or the bare id. Only the subdomain chooses the company, so any other company's id matches nothing.

geography
string[]

An ISO 3166-1 alpha-2 country code. Matches the product's country.

classification
string[]

A CPC code as a URN. Other classification schemes match nothing.

status
enum<string>[]
Available options:
Active,
Deprecated
validOn
string<date>[]

An ISO 8601 date. Matches footprints valid on that date. At most 10 values.

Maximum array length: 10
validAfter
string<date>[]

An ISO 8601 date. Matches footprints whose validity starts after it. At most 10 values.

Maximum array length: 10
validBefore
string<date>[]

An ISO 8601 date. Matches footprints whose validity ends before it. At most 10 values.

Maximum array length: 10
limit
integer

The page size, at most 100.

Required range: x <= 100
offset
integer

Where the page starts. Take it from the Link header's next URL rather than computing it.

Response

A page of PACT v3 product footprints

data
object[]