---
title: "Get internal project - as seen in app"
method: GET
path: "/projects/internal/{projectId}"
tags: ["Projects"]
---

# Get internal project - as seen in app

`GET /projects/internal/{projectId}`

## Request

- Base URL: `https://api.carbonregistry.com`
- URL: `https://api.carbonregistry.com/projects/internal/{projectId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/docs/projects/internal/:projectId/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint returns the given project as seen in app - may be non-reviewed data.

## Path parameters

- `projectId` string, required

## Headers

- `x-icr-api-version` string

## Response `200`

- ProjectResponseDto
  - `project` DetailedApiProjectDto, required
    - `city` string: The city of the project
    - `sector` ApiSectorDto
      - `id` string, required
      - `title` string, required
    - `num` number, required: Project number. This is a unique identifier for the project
    - `id` string, required: The ID of the project
    - `otherBenefits` ApiOtherBenefitDto[]: Other benefits of the project
      - `title` string, required: The title of the benefit
      - `checked` boolean, required: The checked status of the benefit
      - `id` number, required: The ID of the benefit
      - `description` string, required: The description of the benefit
    - `fullName` string, required: The full name of the project
    - `thumbnail` string: The url of the thumbnail of the project
    - `description` string, required: The description of the project
    - `shortDescription` string, required: The short description of the project
    - `proponents` ApiProponentDto[], required: The proponents of the project
      - `fullName` string, required: The full name of the proponent organization
      - `logo` string, required: The url of the logo of the proponent organization
      - `id` string, required: The ID of the proponent organization
      - `publicUrl` string, required: The URL to the organization's public page on the CarbonRegistry.com
    - `publicUrl` string, required: The URL of the project
    - `registry` string, required: The registry of the project
    - `status` 'draft' | 'project_concept' | 'under_development' | 'under_validation' | 'validated' | 'closed' | 'retracted', required: The status of the project
    - `countryCode` string: The ISO 3166-1 alpha-2 country code of the project
    - `state` string: The state of the project
    - `startDate` string, date-time, required: The start date of the project
    - `creditingPeriodStartDate` string, date-time, required: The crediting period start date of the project
    - `methodology` ApiMethodologyDto, required
      - `id` string, required
      - `title` string, required
    - `type` ApiProjectTypeDto, required
      - `id` 'removal' | 'avoidance' | 'hybrid', required: The type id
      - `title` string, required: The title of the type
      - `description` string: Description of the type
    - `estimatedAnnualMitigations` string[], required: The estimated annual mitigations of the project in tCO2
    - `location` ApiLocationDto
      - `lat` number, required: The latitude of the location
      - `lng` number, required: The longitude of the location
    - `kmlFile` ApiDocumentDto
      - `id` string, required: The id of the document
      - `uri` string, required: A downloadbale URI of the document - link lasts for 10min
      - `type` 'proofOfConcept' | 'proofOfOwnership' | 'projectDescription' | 'validationReport' | 'monitoringReport' | 'verificationReport' | 'otherNote' | 'noIssuanceStatement' | 'hostCountryApprovalDocument' | 'kmlFile' | 'representationDeed' | 'projectDesignDescriptionAndMonitoringReport' | 'vvbAgreement' | 'validationAndVerificationReport' | 'methodologyConcept' | 'nonPerformanceReport' | 'reversalEventReport', required: The type of the document
      - `name` string, required: The name of the document
      - `isPublic` boolean, required
    - `validators` ApiProponentDto[], required: The validators of the project
      - `fullName` string, required: The full name of the proponent organization
      - `logo` string, required: The url of the logo of the proponent organization
      - `id` string, required: The ID of the proponent organization
      - `publicUrl` string, required: The URL to the organization's public page on the CarbonRegistry.com
    - `documentation` ApiDocumentDto[], required: The documentation of the project
      - `id` string, required: The id of the document
      - `uri` string, required: A downloadbale URI of the document - link lasts for 10min
      - `type` 'proofOfConcept' | 'proofOfOwnership' | 'projectDescription' | 'validationReport' | 'monitoringReport' | 'verificationReport' | 'otherNote' | 'noIssuanceStatement' | 'hostCountryApprovalDocument' | 'kmlFile' | 'representationDeed' | 'projectDesignDescriptionAndMonitoringReport' | 'vvbAgreement' | 'validationAndVerificationReport' | 'methodologyConcept' | 'nonPerformanceReport' | 'reversalEventReport', required: The type of the document
      - `name` string, required: The name of the document
      - `isPublic` boolean, required
    - `events` ApiProjectEventDto[], required: List of events associated with the project
      - `id` string, required: Unique identifier for the project event
      - `type` 'status_change', required: Type of the project event
      - `createdAt` string, date-time, required: Timestamp when the event was created
      - `projectStatus` 'draft' | 'project_concept' | 'under_development' | 'under_validation' | 'validated' | 'closed' | 'retracted', required: Status of the project after the event
      - `previousProjectStatus` 'draft' | 'project_concept' | 'under_development' | 'under_validation' | 'validated' | 'closed' | 'retracted': Status of the project before the event

---

[API](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api.md) - [All operations](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/revisions/a9f1b102faca?raw)