# Projects

{% hint style="info" %}
**Who can use these endpoints**

You can use any access token to access these endpoints. 
{% endhint %}

### Projects

#### list projects

{% openapi src="/files/e1BPG9KQvvapGzTy8alf" path="/projects" method="get" %}
[openapi.yaml](https://2441265052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfIdoGcZZdvap67xjb5h1%2Fuploads%2Fmabe2nfB82a3vZ8qM4e9%2Fopenapi.yaml?alt=media\&token=b0070a9e-b5c0-4246-9200-1241aa683103)
{% endopenapi %}

Returns a paginated list of all public projects on ICR. 

Callable by any access token regardless of permissions.

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X 'GET' \
  'https://api.carbonregistry.com/projects?limit=10&page=0' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'
```

{% endtab %}

{% tab title="Typescript" %}

{% endtab %}
{% endtabs %}

#### list internal projects

{% openapi src="/files/e1BPG9KQvvapGzTy8alf" path="/projects/internal" method="get" %}
[openapi.yaml](https://2441265052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfIdoGcZZdvap67xjb5h1%2Fuploads%2Fmabe2nfB82a3vZ8qM4e9%2Fopenapi.yaml?alt=media\&token=b0070a9e-b5c0-4246-9200-1241aa683103)
{% endopenapi %}

Returns a paginated list of all projects on ICR. 

Callable by any access token with permissions "[examiner:read](/documentation/carbonregistry.com/api/apps/creating-icr-apps/registering-an-icr-app/permissions.md#users)".

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X 'GET' \
  'https://api.carbonregistry.com/projects/internal?limit=10&page=0' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'
```

{% endtab %}
{% endtabs %}

#### Get internal project

{% openapi src="/files/e1BPG9KQvvapGzTy8alf" path="/projects/internal/{projectId}" method="get" %}
[openapi.yaml](https://2441265052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfIdoGcZZdvap67xjb5h1%2Fuploads%2Fmabe2nfB82a3vZ8qM4e9%2Fopenapi.yaml?alt=media\&token=b0070a9e-b5c0-4246-9200-1241aa683103)
{% endopenapi %}

Returns the project as seen on ICR. 

Callable by any access token with permissions "[examiner:read](/documentation/carbonregistry.com/api/apps/creating-icr-apps/registering-an-icr-app/permissions.md#users)".

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X 'GET' \
  'https://api.carbonregistry.com/projects/internal/:id' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'
```

{% endtab %}
{% endtabs %}

#### get project based on credit serialization / creditId

{% openapi src="/files/e1BPG9KQvvapGzTy8alf" path="/projects/find/project" method="get" %}
[openapi.yaml](https://2441265052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfIdoGcZZdvap67xjb5h1%2Fuploads%2Fmabe2nfB82a3vZ8qM4e9%2Fopenapi.yaml?alt=media\&token=b0070a9e-b5c0-4246-9200-1241aa683103)
{% endopenapi %}

If you have a creditId or a serialization for a credit you can use this endpoint to get the project that issued the credits.

Callable by any access token regardless of permissions.

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X 'GET' \
  'https://api.carbonregistry.com/projects/find/project?serialization=ICR-ISL-354-78040-14-R-0-2021&creditId=exPost-2-0x51298f2f1142ecb129a2db5e6afd24f34f2e53f1' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'
```

{% endtab %}

{% tab title="Typescript" %}

{% endtab %}
{% endtabs %}

#### specific project

{% openapi src="/files/e1BPG9KQvvapGzTy8alf" path="/projects/{id}" method="get" %}
[openapi.yaml](https://2441265052-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfIdoGcZZdvap67xjb5h1%2Fuploads%2Fmabe2nfB82a3vZ8qM4e9%2Fopenapi.yaml?alt=media\&token=b0070a9e-b5c0-4246-9200-1241aa683103)
{% endopenapi %}

This endpoint returns the project given the projectId.

Callable by any access token regardless of permissions.

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X 'GET' \
  'https://api.carbonregistry.com/projects/{PROJECT_ID}' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'
```

{% endtab %}

{% tab title="Typescript" %}

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.carbonregistry.com/documentation/carbonregistry.com/api/endpoints/v0.5/projects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.