Skip to main content
GET
/
project-types
Project Types
curl --request GET \
  --url https://api.example.com/project-types \
  --header 'X-API-KEY: <x-api-key>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "scope_name": "<string>"
    }
  ]
}

​
Project Types API

Access information about different types of carbon offset projects and their categorization.

​
Authorizations

​
X-API-KEY
string
required
API key for authentication.

​
Endpoint

​
Get All Project Types

​
name
string
Filter by project type name
​
scope
string
Filter by scope ID or name
​
page
integer
Page number for pagination
​
page_size
integer
default:"10"
Number of results per page (max: 100)

​
Response

​
count
integer
Total number of project types
​
next
string
URL for next page of results
​
previous
string
URL for previous page of results
​
results
array

​
Example Request

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

# Get forestry-related project types
params = {
    'name': 'forestry',
    'page_size': 50
}

response = requests.get(
    'https://api.carbonapi.com/project-types',
    headers=headers,
    params=params
)

​
Example Response

{
  "count": 25,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "REDD+",
      "description": "Reducing emissions from deforestation and forest degradation",
      "scope_name": "Forestry and Land Use"
    },
    {
      "id": 2,
      "name": "Afforestation/Reforestation",
      "description": "Establishment of forest on previously unforested land",
      "scope_name": "Forestry and Land Use"
    }
  ]
}