PACT|

    API Reference

    v3.0.3WBCSD PACT

    Introduction

    The ClimatePoint PACT API provides programmatic access to product carbon footprint data conformant with the WBCSD PACT standard, version 3.0.3. Use it to exchange product footprint data with trading partners and supply chain systems.

    Base URL|https://pact.climatepoint.com/api

    All API requests except /.well-known/openid-configuration require a Bearer token in the Authorization header. Tokens expire after 3600 seconds.

    POST/auth/token

    Exchange client credentials for a Bearer access token using the OAuth 2.0 client credentials flow (RFC 6749). Pass credentials via HTTP Basic Auth (recommended) or as form body parameters.

    Request
    grant_typerequired
    string
    Must be "client_credentials"
    client_id
    string
    Client ID — alternative to HTTP Basic Auth
    client_secret
    string
    Client secret — alternative to HTTP Basic Auth
    Response
    access_tokenrequired
    string
    Bearer token for subsequent API requests
    token_typerequired
    string
    Always "Bearer"
    expires_inrequired
    integer
    Token lifetime in seconds (3600)
    scoperequired
    string
    "PACT.read"
    Requests are rate limited per IP and client_id. Client secrets are stored as bcrypt hashes — never share your client secret.
    GET/3/footprints

    Returns a paginated list of product carbon footprints. Uses cursor-based pagination by default; offset-based pagination is also supported for PACT TC5 conformance. Pagination links appear in the Link response header (RFC 5988).

    Query Parameters
    limit
    integer
    Max results per page (default: 100)
    cursor
    string
    Pagination cursor from previous Link header
    offset
    integer
    Offset-based pagination (alternative to cursor)
    productId
    string
    Filter by product URN
    companyId
    string
    Filter by company URN
    geography
    string
    Filter by geography code (ISO 3166-1 alpha-2)
    status
    string
    "Active" or "Deprecated"
    validOn
    date-time
    Footprints valid on this timestamp (ISO 8601)
    Rate limited to 60 requests/minute per client_id.
    GET/3/footprints/{id}

    Retrieves a single product carbon footprint by UUID. Accepts both bare UUID and urn:uuid:... formats. Returns 404 for missing or malformed IDs.

    Path Parameters
    idrequired
    uuid
    Footprint UUID — bare UUID or urn:uuid:... format
    Response (data)
    idrequired
    string
    Footprint URN (urn:uuid:...)
    specVersionrequired
    string
    PACT spec version (3.0.3)
    versionrequired
    integer
    Footprint version number
    statusrequired
    string
    "Active" or "Deprecated"
    companyNamerequired
    string
    Manufacturer or company name
    productNameCompanyrequired
    string
    Product name as used by the company
    pcfrequired
    object
    Carbon footprint data (PACT CarbonFootprint type)
    POST/3/events

    Submit a PACT v3.0.3 CloudEvent to notify the system of footprint publications, data sharing requests, and request status changes. The request body must use the application/cloudevents+json content type.

    CloudEvent Fields
    specversionrequired
    string
    "1.0" — CloudEvents specification version
    idrequired
    string
    Unique event identifier
    sourcerequired
    uri
    URI identifying the sending system
    typerequired
    string
    PACT event type (see supported types below)
    time
    date-time
    Event timestamp in ISO 8601 format
    Supported Event Types
    org.wbcsd.pathfinder.ProductFootprint.Published.v1A new product footprint has been published
    org.wbcsd.pathfinder.ProductFootprintRequest.Created.v1A data sharing request has been created
    org.wbcsd.pathfinder.ProductFootprintRequest.Fulfilled.v1A data sharing request has been fulfilled
    org.wbcsd.pathfinder.ProductFootprintRequest.Rejected.v1A data sharing request has been rejected
    Request body is capped at 1 MB. Returns 200 with an empty body on success — this is per the PACT conformance specification.
    GET/.well-known/openid-configuration

    Returns the OpenID Connect discovery document for the authorization server. Use this to programmatically discover the token endpoint and supported authentication methods.

    No authentication required — this endpoint is publicly accessible.
    Introduction
    # ClimatePoint PACT API — v3.0.3
    # WBCSD PACT standard compliant
    #
    # Base URL
    BASE_URL="https://pact.climatepoint.com/api"
    
    # All requests require Bearer token auth.
    # Obtain a token via POST /auth/token