Projects

Environmental projects generating verified carbon or ecological credits.

Search projects

post

Search projects by filters

Body

application/json

categoryIdsstring[]Optional

Filter by category IDs

policyIdsstring[]Optional

Filter by policy IDs

Responses

202

Successful operation.

application/json

idstringRequired

policyIdstringRequired

policyNamestringRequired

registeredstringRequired

titlestringRequired

companyNamestringRequired

sectoralScopestringRequired

500

Internal server error.

application/json

post/projects/search

HTTPcURLJavaScriptPython

POST /api/v1/projects/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "policyIds": [
    "69aeb71ef8c5b278e3bab4e5"
  ]
}

Filter by policy IDsGet all projects

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "policyId": "69aeb71ef8c5b278e3bab4e5",
    "policyName": "string",
    "registered": "string",
    "title": "string",
    "companyName": "string",
    "sectoralScope": "string"
  }
]

Compare documents.

post

Compare documents.

Body

application/json

idLvlone ofOptionalExample: 0

string · enumOptionalPossible values:

or

number · enumOptionalPossible values:

eventsLvlone ofOptionalExample: 0

string · enumOptionalPossible values:

or

number · enumOptionalPossible values:

propLvlone ofOptionalExample: 0

string · enumOptionalPossible values:

or

number · enumOptionalPossible values:

childrenLvlone ofOptionalExample: 0

string · enumOptionalPossible values:

or

number · enumOptionalPossible values:

documentId1stringOptionalExample: 69aeb71ef8c5b278e3bab4e5

documentId2stringOptionalExample: 69b8115f3dc0fa022156fb89

documentIdsstring[]OptionalExample: ["69aeb71ef8c5b278e3bab4e5","69b8115f3dc0fa022156fb89"]

Responses

200

Successful operation.

application/json

422

Unprocessable entity.

application/json

500

Internal server error.

application/json

post/projects/compare/documents

HTTPcURLJavaScriptPython

POST /api/v1/projects/compare/documents HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "documentId1": "69aeb71ef8c5b278e3bab4e5",
  "documentId2": "69aeb71ef8c5b278e3bab4e5"
}

Filter1Filter2

{
  "projects": {
    "documents": {},
    "left": {},
    "right": {},
    "total": {}
  },
  "presentations": {
    "documents": {},
    "left": {},
    "right": {},
    "total": {}
  }
}

Get all properties

get

Get all properties

Responses

202

Successful operation.

application/json

idstringRequired

titlestringRequired

valuestringRequired

500

Internal server error.

application/json

get/projects/properties

HTTPcURLJavaScriptPython

GET /api/v1/projects/properties HTTP/1.1
Accept: */*

[
  {
    "id": "69aeb71ef8c5b278e3bab4e5",
    "title": "string",
    "value": "string"
  }
]