Retrieve a Product
Retrieve details about a specific product
Bearer-AuthAuthorizationBearer <token>id*stringThe product ID
locale?LocaleDescriptions of products can be localized.
^(?:[a-z]{2}|[a-z]{2}-[A-Z]{2})$2 <= length <= 5"en""de""en""es""fr""hi""it""ja""pt""pt-BR""zh-CN"OK
application/json- response
A product is any purchasable compensation option SQUAKE offers. In the simplest case, a product maps to a single project such as "GoodShipping Sustainable Biofuel for Shipping". Depending on client need, SQUAKE also offers bundles of multiple projects; these can be centered around specific goals, e.g., "carbon avoidance", or mixed to achieve a particular price point. Feel free to contact us for more information or custom products.
id*stringproduct_[A-Za-z0-9]*locations?array<>List of all locations impacted by the projects used in this product.
certifications?array<>List of all certifications the projects for this product hold.
title?stringA short human readable summary of the description.
description?stringA human readable description.
sdgs?array<>The Sustainable Development Goals (SDGs) aim to transform our world. They are a call to action to end poverty and inequality, protect the planet, and ensure that all people enjoy health, justice and prosperity.
files?array<>Images attached to the product.
prices?array<>Multiple prices may exist, for example, when future price changes are already known.
categories?array<>impact_types?array<>classes?array<>curl -X GET 'https://api.sandbox.squake.earth/v2/products/string'{ "id": "product_2rsg35sfsdf", "locations": [ { "country": "DE", "sub_region": "150", "region": "155" } ], "certifications": [ "European Biochar Certification" ], "title": "string", "description": "string", "sdgs": [ 7 ], "files": [ { "id": "file_asfg454s25", "filename": "string", "purpose": "confirmation_document", "size": 0, "type": "pdf", "download_url": "http://example.com", "notification": "string" } ], "prices": [ { "id": "price_1MMroL2eZvKYlo2CxbxAACvb", "product": "prod_N760vOJBvdEDY8", "unit_amount": 2500, "carbon_unit": "tonne", "currency": "EUR" } ], "categories": [ { "code": "forestry_and_land_use", "title": "Forestry and Land Use" } ], "impact_types": [ { "code": "avoidance", "title": "Avoidance" } ], "classes": [ { "code": "technology_based", "title": "Technology based" } ]}Invite a User
Invites a user to one of the authenticated client's sub-clients. The user is created if they don't already exist, or reused if the email address already belongs to a user of that sub-client. An invitation email is then queued. This endpoint only supports sub-clients: `client_id` must refer to a sub-client of the authenticated client. You can't invite users to the authenticated client itself. Omitting `client_id` also targets the authenticated client (as it does elsewhere in v2), so both cases return `client_not_invitable` (`403`). To manage users in your own organization, use the SQUAKE Dashboard. Re-inviting the same email address for the same sub-client is safe. The existing invitation is returned with an updated `sent_at`, and the email is sent again. The acceptance URL stays the same, so any previously sent invitation link will continue to work. If `locale` is omitted when re-inviting a user, the locale from the previous invitation is preserved.
Retrieve Products
A product is any purchasable compensation option SQUAKE offers. In the simplest case, a product maps to a single climate project such as "Sustainable Biofuel for Shipping". Depending on client need, SQUAKE also offers bundles of multiple climate projects; these can be centered around specific goals, e.g.,"carbon reduction", "location", or what is desired to achieve a particular price point or sustainability goal. Feel free to contact us for more information or custom products.