Skip to main content
GET
/
v1
/
projects
/
{project_id}
Get Project
const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/projects/{project_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "description": {},
  "start_date": {},
  "end_date": {},
  "due_date": {},
  "project_type": {},
  "methodology": {},
  "responsible_user_id": "<string>",
  "responsible_user": {
    "id": "<string>",
    "email": "<string>",
    "first_name": {},
    "last_name": {}
  },
  "parent": {
    "id": "<string>",
    "name": "<string>"
  },
  "created_at": {},
  "updated_at": {}
}

​
Get Project

Retrieve detailed information about a specific project using its unique identifier.

​
Request

​
Headers

​
x-api-key
string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
​
x-organization-id
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

​
Path Parameters

​
project_id
string
required
The unique identifier (UUID) of the project to retrieveExample: 550e8400-e29b-41d4-a716-446655440000

​
Response

​
id
string
Unique identifier (UUID)
​
organization_id
string
Organization UUID
​
name
string
Project name
​
description
string | null
Project description
​
start_date
date | null
Project start date (YYYY-MM-DD)
​
end_date
date | null
Project end date (YYYY-MM-DD)
​
due_date
date | null
Project due date (YYYY-MM-DD)
​
project_type
string | null
Project type classificationPossible values: carbon_footprint, custom, einf, iso_14064, iso_14001, iso_9001, acv, visualization, suppliers, logistics
​
methodology
string | null
Reporting methodologyPossible values: esrs, gri, glec
​
responsible_user_id
string
UUID of the user responsible for the project
​
responsible_user
object
Responsible user details
​
parent
object | null
Parent organization info (if project is inherited from a parent org)
​
created_at
datetime
Timestamp when the project was created
​
updated_at
datetime
Timestamp when the project was last updated

​
Example

curl -X GET "https://api.dcycle.io/v1/projects/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

​
Successful Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
  "name": "Carbon Footprint 2024",
  "description": "Annual carbon footprint calculation for FY2024",
  "start_date": "2024-01-01",
  "end_date": "2024-12-31",
  "due_date": "2025-03-31",
  "project_type": "carbon_footprint",
  "methodology": "gri",
  "responsible_user_id": "user-uuid-001",
  "responsible_user": {
    "id": "user-uuid-001",
    "email": "maria@company.com",
    "first_name": "Maria",
    "last_name": "Garcia"
  },
  "parent": null,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-20T14:45:00Z"
}

​
Common Errors

​
401 Unauthorized

Cause: Missing or invalid API key 
{
  "detail": "Invalid API key",
  "code": "INVALID_API_KEY"
}
Solution: Verify your API key is valid and active.

​
404 Not Found

Cause: Project not found or doesn’t belong to your organization 
{
  "detail": "Project not found"
}
Solution: Verify the project ID exists and belongs to the organization specified in the header. Projects from parent organizations are also accessible.

​
422 Validation Error

Cause: Invalid project ID format 
{
  "detail": [
    {
      "loc": ["path", "project_id"],
      "msg": "value is not a valid uuid",
      "type": "type_error.uuid"
    }
  ]
}
Solution: Ensure the project ID is a valid UUID format.

List Projects

Retrieve all projects

Update Project

Modify project details

Delete Project

Remove a project

Link Entities

Link entities to a project