Skip to main content
GET
List Purchases

List Purchases

Retrieve all purchases (Scope 3 - Category 1: Purchased Goods and Services) registered in your organization with pagination support and flexible filtering options.
Purchases represent Scope 3 emissions from goods and services your organization buys. This is typically one of the largest emission categories for most organizations.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: ff4adcc7-8172-45fe-9cf1-e90a6de53aa9
string
required
Your user UUIDExample: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Query Parameters

integer
default:"1"
Page number for paginationExample: 1
integer
default:"50"
Number of items per page (max: 100)Example: 50
string
Advanced filtering criteria (format: field:operator:value or field:value)Supported operators:
  • eq - Equals
  • neq - Not equals
  • in - In list
  • nin - Not in list
  • gt - Greater than
  • gte - Greater than or equal
  • lt - Less than
  • lte - Less than or equal
Example: "status:active" or "sector:eqIT Services"
string
Sort criteria (format: field:asc or field:desc)Sortable fields:
  • purchase_date
  • quantity
  • co2e
  • sector
  • status
Example: "co2e:desc"

Response

integer
Current page number
integer
Number of items per page
integer
Total count of active purchases
integer
Total count of purchases with errors or in review status
array
Array of purchase objects

Purchase Object Fields:

string
Unique purchase identifier (UUID v4)
string
Organization UUID
float
Purchase quantity
string
Unit UUID for the quantity
object
Unit details object with id, name, type fields
string
Economic sector code (NAICS or similar classification)Examples: "IT Services", "Manufacturing", "Transportation"
string
Product or service nameExamples: "Laptops", "Cloud Services", "Office Supplies"
string
Type of purchase calculation methodValues:
  • spend_based - Calculated based on monetary spend (most common)
  • supplier_specific - Uses supplier-specific emission factors
string
Expense categoryValues: "goods", "services", "capital_goods", "other"
string
Supplier UUID (for spend_based purchases)
object
Supplier details object with business_name and country fields
datetime
Date of purchase (ISO 8601 format)
datetime
Last update timestamp (ISO 8601 format)
float
Percentage of recycled content (0.0 to 1.0)
string
ISO 3166-1 alpha-2 country code where purchase was made
string
Purchase frequency for recurring purchasesValues: "once", "weekly", "monthly", "quarterly", "yearly"
string
Purchase description or notes
string
Purchase statusValues:
  • active - Successfully processed
  • success - Successfully processed (legacy)
  • error - Processing failed
  • in_review - Pending review
float
Total CO2 equivalent emissions in kg
float
Emission factor used for calculation (kg CO2e per unit)
boolean
Whether to display GHG sector scope information
string
UUID of custom emission factor (if using supplier-specific method)
string
URL of uploaded file (for bulk uploads)
string
UUID of uploaded file
string
Name of uploaded file

Example

Successful Response

Common Errors

400 Bad Request

Cause: Invalid query parameters or filter format
Solution: Verify that filter_by and sort_by follow the correct format.

403 Forbidden

Cause: Organization ID doesn’t match your API key or user doesn’t belong to organization
Solution: Verify that x-organization-id matches your API key’s organization.

Use Cases

Get Purchases Dashboard

Display all active purchases with highest emissions:

Filter by Sector

Get all purchases in a specific sector:

Filter by Date Range

Get purchases within a specific time period:

Get Purchases with Errors

Identify and review purchases that failed processing:

Analyze Emissions by Sector

Group purchases and calculate emissions by sector:

Purchase Types

Spend-Based Purchases

Description: Emissions calculated based on monetary spend using economic input-output emission factors. Characteristics:
  • Most common method (80-90% of purchases)
  • Requires: quantity (in currency), sector, country
  • Uses standardized emission factors per EUR/USD spent
  • Less accurate but practical for most purchases
Example: €25,000 spent on IT services

Supplier-Specific Purchases

Description: Emissions calculated using supplier-provided product-specific emission factors. Characteristics:
  • More accurate than spend-based
  • Requires: product name, supplier, specific emission factor
  • Used when supplier provides LCA data
  • Ideal for major suppliers or critical products
Example: 1000 kg of supplier-certified sustainable paper

Expense Types

Frequency Options

Recurring purchases can be tracked with frequency:

Best Practices

1. Use Pagination Effectively

When you have many purchases, use pagination:

2. Filter for Performance

Use server-side filtering instead of loading everything:

3. Monitor Error Status

Regularly check for purchases with errors:

4. Sort by Emissions

Focus on high-impact purchases first:

Bulk Upload Purchases

Upload multiple purchases via CSV

List Units

Get measurement units for purchases

List Facilities

View your facilities

Authentication

Learn about API authentication