---
title: "Retrieves a project"
method: GET
path: "/v1/projects/{id}"
tags: ["Projects"]
---

# Retrieves a project

`GET /v1/projects/{id}`

Retrieves a project available on Patch's platform.

## Path parameters

- `id` string, required

## Headers

- `Accept-Language` string
- `Patch-Version` integer

## Response `200`

Returns the requested project

- object
  - `success` boolean, required
  - `error` object, nullable, required
  - `data` Project, required
    - `id` string, required — A unique uid for the record. UIDs will be prepended by pro_prod or pro_test depending on the mode it was created in.
    - `production` boolean, required — A boolean indicating if this project is a production or demo mode project.
    - `name` string, required — The name of the project.
    - `description` string, required — The description of the project.
    - `type` string — DEPRECATED. Favor the technology_type field instead.
    - `mechanism` string — The mechanism of the project. One of: removal, avoidance, avoidance_and_removal.
    - `country` string, required — The country of origin of the project.
    - `state` string, nullable — The state where this project is located.
    - `latitude` number, float, nullable — The latitude at which this project is located.
    - `longitude` number, float, nullable — The longitude at which this project is located.
    - `developer` string, required — The name of the project developer.
    - `photos` Photo[], nullable — An array of URLs for photos of the project.
      - `url` string, required
      - `id` string, required
    - `average_price_per_tonne_cents_usd` integer, required — DEPRECATED. The average price per tonne in USD cents for carbon offsets supplied by this project.
    - `remaining_mass_g` integer, required — DEPRECATED. The remaining mass in grams available for purchase for this project.
    - `verifier` string — The name of the project verifier, when applicable. A verifier is the organization that verifies the calculations of the actual amount of greenhouse gas emissions that have been avoided or sequestered through implementation of the project.
    - `standard` Standard
      - `type` string, required — The standard type.
      - `acronym` string, required — The acronym for the standard.
      - `description` string, required — The description of the standard.
    - `sdgs` Sdg[], nullable — An array returning the UN Sustainable Development Goals associated with this project.
      - `title` string, required — The title of the Sustainable Development Goal.
      - `number` integer, required — The Sustainable Development Goal number.
      - `description` string, required — The description of the Sustainable Development Goal.
      - `url` string, required — The url to an information page for the Sustainable Development Goal.
    - `tagline` string — A short description of the project.
    - `technology_type` TechnologyType, required — An object containing the technology type's name, slug and parent_technology_type.
      - `slug` string, required — Unique identifier for this type of technology.
      - `name` string, required — Display name of this technology type.
      - `parent_technology_type` object — An object containing the parent technology type's name and slug.
        - `slug` string — Unique identifier for this type of technology.
        - `name` string — Name of this technology type.
    - `highlights` Highlight[], required — DEPRECATED. An array of objects containing the highlight's slug, title, and a URL for the corresponding icon. A highlight's title is a short string that spotlights a characteristic about the project. Highlights are deprecated and not populated for recent projects.
      - `slug` string, required — A unique identifier for each highlight.
      - `title` string, required — A short string that spotlights a characteristic about the project.
      - `icon_url` string, required — A URL for the corresponding icon.
    - `inventory` Inventory[], required — An array of objects containing available inventory for a project. Available inventory is grouped by a project's vintage year and returns amount and pricing available for a given vintage year.
      - `vintage_year` integer, required — The year in which the climate impacts of the project occurred, or will occur.
      - `amount_available` integer, required — The amount available for this vintage year.
      - `price` integer, required — The price per tonne (1,000,000 g) or MWh (1,000,000 Wh) of inventory. Prices are always represented in the smallest currency unit (ie cents for USD).
      - `currency` string, required — The currency code for `price`.
      - `unit` string, required — The unit of measurement (ie "g" or "Wh") for `amount_available`.

## Other responses

- `403` — a production project with test credentials
- `404` — a non-existent project

---

[API](https://skmtc.dev/patch/apis/patch-api-v1.md) · [All operations](https://skmtc.dev/patch/apis/patch-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/patch/patch-api-v1/revisions/9de29e2a01fc/schema)