Skip to main content
GET
Retrieve a project

Authorizations

Authorization
string
header
required

Path Parameters

project_id
string
required

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

Response

The project.

A single project, with its custom fields resolved and a link into the app.

id
string

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

Example:

"prj_aBcD1234eFgH5678"

name
string
description
string | null
project_type
string | null
credit_types
string[]
country
string | null

Country of the project's primary location's address.

state
string | null

State of the project's primary location's address.

project_status
string | null
registry_id
integer | null

Numeric ID of the project's registry.

registry_name
string | null
methodology
string | null
inventory
object

Available credit balances from active issuances, split into spot (issued) and forecast. Each period and total carries a total plus one key per credit type name.

images
object[]
sustainable_development_goals
string[]
field_values
object

Custom field values keyed by custom field definition key.

custom_fields
object[]

One entry per custom field definition that applies to the project, whether or not it has a value.

ui_url
string<uri>

Link that opens this project in the Mangrove app.

Example:

"https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678"