Documents

Documents

Get a link to a project document

Given the id of a project document (gotten from one of the project endpoints) you can supply that to this endpoint to get a link where you can download the document.

Get usable document download link

This endpoint returns a link to the document specified.

GEThttps://api.carbonregistry.com/documents/{id}/link

Path parameters

id*string

Response

200

Body

application/json

link*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/documents/{id}/link', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "link": "text"
}

Callable by any access token regardless of permissions - unless the document is marked as private then only callable by access token with permissions "examiner:read".

cURL

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'