> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Project

> Retrieve a specific project by its ID

# Get Project

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

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

### Path Parameters

<ParamField path="project_id" type="string" required>
  The unique identifier (UUID) of the project to retrieve

  **Example:** `550e8400-e29b-41d4-a716-446655440000`
</ParamField>

## Response

<ResponseField name="id" type="string">
  Unique identifier (UUID)
</ResponseField>

<ResponseField name="organization_id" type="string">
  Organization UUID
</ResponseField>

<ResponseField name="name" type="string">
  Project name
</ResponseField>

<ResponseField name="description" type="string | null">
  Project description
</ResponseField>

<ResponseField name="start_date" type="date | null">
  Project start date (YYYY-MM-DD)
</ResponseField>

<ResponseField name="end_date" type="date | null">
  Project end date (YYYY-MM-DD)
</ResponseField>

<ResponseField name="due_date" type="date | null">
  Project due date (YYYY-MM-DD)
</ResponseField>

<ResponseField name="project_type" type="string | null">
  Project type classification

  **Possible values:** `carbon_footprint`, `custom`, `einf`, `iso_14064`, `iso_14001`, `iso_9001`, `acv`, `visualization`, `suppliers`, `logistics`
</ResponseField>

<ResponseField name="methodology" type="string | null">
  Reporting methodology

  **Possible values:** `esrs`, `gri`, `glec`
</ResponseField>

<ResponseField name="responsible_user_id" type="string">
  UUID of the user responsible for the project
</ResponseField>

<ResponseField name="responsible_user" type="object">
  Responsible user details

  <Expandable title="User Object">
    <ResponseField name="id" type="string">
      User UUID
    </ResponseField>

    <ResponseField name="email" type="string">
      User email
    </ResponseField>

    <ResponseField name="first_name" type="string | null">
      First name
    </ResponseField>

    <ResponseField name="last_name" type="string | null">
      Last name
    </ResponseField>

    <ResponseField name="profile_img_url" type="string | null">
      Profile image URL
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="parent" type="object | null">
  Parent organization info (if project is inherited from a parent org)

  <Expandable title="Parent Object">
    <ResponseField name="id" type="string">
      Parent organization UUID
    </ResponseField>

    <ResponseField name="name" type="string">
      Parent organization name
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="created_at" type="datetime">
  Timestamp when the project was created
</ResponseField>

<ResponseField name="updated_at" type="datetime | null">
  Timestamp when the project was last updated
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  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}"
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  api_key = os.getenv("DCYCLE_API_KEY")
  org_id = os.getenv("DCYCLE_ORG_ID")

  headers = {
      "x-api-key": api_key,
      "x-organization-id": org_id
  }

  project_id = "550e8400-e29b-41d4-a716-446655440000"

  response = requests.get(
      f"https://api.dcycle.io/v1/projects/{project_id}",
      headers=headers
  )

  project = response.json()
  print(f"Project: {project['name']}")
  print(f"Type: {project['project_type']}")
  print(f"Responsible: {project['responsible_user']['email']}")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const apiKey = process.env.DCYCLE_API_KEY;
  const orgId = process.env.DCYCLE_ORG_ID;

  const headers = {
    'x-api-key': apiKey,
    'x-organization-id': orgId
  };

  const projectId = '550e8400-e29b-41d4-a716-446655440000';

  axios.get(
    `https://api.dcycle.io/v1/projects/${projectId}`,
    { headers }
  )
  .then(response => {
    const project = response.data;
    console.log(`Project: ${project.name}`);
    console.log(`Type: ${project.project_type}`);
    console.log(`Responsible: ${project.responsible_user.email}`);
  })
  .catch(error => console.error(error));
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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",
    "profile_img_url": null
  },
  "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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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.

## Related Endpoints

<CardGroup cols={2}>
  <Card title="List Projects" icon="list" href="/api-reference/projects/list">
    Retrieve all projects
  </Card>

  <Card title="Update Project" icon="pencil" href="/api-reference/projects/update">
    Modify project details
  </Card>

  <Card title="Delete Project" icon="trash" href="/api-reference/projects/delete">
    Remove a project
  </Card>

  <Card title="Link Entities" icon="link" href="/api-reference/projects/link-entities">
    Link entities to a project
  </Card>
</CardGroup>