Skip to main content

Project Tools

Query ESG projects — reporting periods, task tracking, dashboards, and recent activity. Projects group data by framework (GHG Protocol, ISO 14064, LCA, etc.) and contain tasks, files, and dashboards.

list_projects

List projects for the organization with optional framework filter. Parameters:
ParameterTypeRequiredDefaultDescription
organization_idstringNodefault orgOrganization UUID
frameworkstringNoFilter by project type (see below)
ValueDescription
carbon_footprintGHG Protocol carbon footprint
esrsEuropean Sustainability Reporting Standards (EINF + ESRS methodology)
griGlobal Reporting Initiative (EINF + GRI methodology)
lcaLife Cycle Assessment
logisticsLogistics & GLEC framework
decarbonization_planDecarbonization planning
customCustom project
Example response:
[
  {
    "id": "p5e6f7a8-...",
    "name": "Carbon Footprint 2024",
    "description": "Annual GHG Protocol reporting",
    "project_type": "carbon_footprint",
    "methodology": "gri",
    "start_date": "2024-01-01",
    "end_date": "2024-12-31",
    "due_date": "2025-03-31",
    "organization_id": "a1b2c3d4-...",
    "responsible_user": {
      "id": "u1a2b3c4-...",
      "first_name": "María",
      "last_name": "García",
      "email": "maria@company.com"
    },
    "extended": {
      "number_of_files": 45,
      "number_of_widgets": 8,
      "number_of_tasks": 12,
      "number_of_tasks_completed": 7
    },
    "created_at": "2024-01-15T10:00:00",
    "updated_at": "2025-02-20T14:30:00"
  }
]
Key response fields:
FieldDescription
project_typeFramework type (see project types above)
methodologyReporting methodology: esrs, gri, glec, or custom
start_date / end_dateReporting period
due_dateProject deadline
responsible_userUser responsible for the project
extendedSummary counts: files, widgets, tasks, tasks completed

get_project

Get a single project by ID with full details including progress metrics and responsible user. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesUUID of the project
organization_idstringNodefault orgOrganization UUID
Example response:
{
  "id": "p5e6f7a8-...",
  "name": "Carbon Footprint 2024",
  "description": "Annual GHG Protocol reporting for all facilities",
  "project_type": "carbon_footprint",
  "methodology": "gri",
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "due_date": "2025-03-31",
  "organization_id": "a1b2c3d4-...",
  "responsible_user": {
    "id": "u1a2b3c4-...",
    "first_name": "María",
    "last_name": "García",
    "email": "maria@company.com"
  },
  "extended": {
    "number_of_files": 45,
    "number_of_widgets": 8,
    "number_of_tasks": 12,
    "number_of_tasks_completed": 7
  },
  "created_at": "2024-01-15T10:00:00",
  "updated_at": "2025-02-20T14:30:00"
}
Use list_projects first to find project IDs, then list_project_tasks for the task breakdown.

list_project_tasks

List tasks and subtasks within a project. Returns each task’s status, assignee, due date, and nested subtasks — useful for tracking ESG action-item progress. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesUUID of the project
organization_idstringNodefault orgOrganization UUID
Example response:
[
  {
    "id": "task-1a2b3c4d-...",
    "title": "Upload electricity invoices Q1-Q4",
    "status": "done",
    "assignee": {
      "id": "u1a2b3c4-...",
      "first_name": "María",
      "last_name": "García"
    },
    "due_date": "2025-02-15",
    "subtasks": [
      {
        "id": "task-5e6f7a8b-...",
        "title": "Verify Q3 consumption data",
        "status": "in_progress",
        "assignee": null,
        "due_date": null
      }
    ]
  },
  {
    "id": "task-9c0d1e2f-...",
    "title": "Review Scope 3 emission factors",
    "status": "pending",
    "assignee": null,
    "due_date": "2025-03-01",
    "subtasks": []
  }
]
Key response fields:
FieldDescription
statusTask state: pending, in_progress, or done
assigneeOrganization member assigned to the task (null if unassigned)
subtasksNested array of child tasks with the same structure

get_recent_activities

Get the recent activity feed for a project — data uploads, task completions, and configuration changes. Parameters:
ParameterTypeRequiredDefaultDescription
project_idstringYesUUID of the project
organization_idstringNodefault orgOrganization UUID
limitintegerNo10Number of activities (1–50)
Example response:
[
  {
    "id": "act-1a2b3c4d-...",
    "action": "file_uploaded",
    "description": "Uploaded electricity invoices for Barcelona office",
    "user": {
      "id": "u1a2b3c4-...",
      "first_name": "María",
      "last_name": "García"
    },
    "created_at": "2025-02-18T09:30:00"
  },
  {
    "id": "act-5e6f7a8b-...",
    "action": "task_completed",
    "description": "Marked 'Upload electricity invoices Q1-Q4' as done",
    "user": {
      "id": "u1a2b3c4-...",
      "first_name": "María",
      "last_name": "García"
    },
    "created_at": "2025-02-17T16:45:00"
  }
]
Example prompts:
"List all our ESG projects"
"Show our carbon footprint projects"
"What tasks are pending in our GHG project?"
"Show recent activity on the ISO 14064 project"
"Which projects are due this quarter?"
"How many tasks are completed in project abc-123?"

Workflow

  1. List projectslist_projects to discover available projects, optionally filtered by framework
  2. Get detailsget_project for full project information and responsible user
  3. Check taskslist_project_tasks to see task breakdown and completion status
  4. Track activityget_recent_activities for recent changes and data uploads
  5. View dashboardslist_dashboards to find dashboards linked to the project

Dashboards

Dashboard widgets linked to projects

Decarbonization

Decarbonization plans linked to projects

Members

Organization members assigned to project tasks

API Reference

REST API endpoints for projects

CLI

Manage projects from the command line