Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.worldly.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Search Parameters

Use this endpoint to search for Higg Index Facility Environmental Modules (FEM) that are available to import and link with purchase orders.
Note: only FEMs that have been posted by the facility will be eligible for import and linking in the Scope 3 tool. However, FEMs do not need to be verified.
{
  "from": 0,
  "size": 0,
  "ids": [
    "string"
  ],
  "textSearch": "string",
  "moduleType": "fem2020",
  "status": "NS",
  "country": "string"
}

​
Search Results

In order to link a FEM with a purchase order, you will need at least the module’s ID known as the femId. The status field indicates which stage of completion the given FEM is in. 
{
  "from": 0,
  "size": 0,
  "total": 0,
  "results": [
    {
      "_id": "string",
      "_rev": "string",
      "moduleType": "string",
      "type": "string",
      "annualProd": "string",
      "totalNormalizedImpacts": 0,
      "femId": "string",
      "country": "string",
      "tags": [
        "string"
      ],
      "customIds": [
        "string"
      ],
      "facilityAccount": {
        "_id": "string",
        "name": "string",
        "country": "string",
        "sacId": 0,
        "oar_id": "string",
        "demoaccount": true,
        "vbType": "None",
        "socialCreditId": "string",
        "taxId": "string",
        "bluesignId": "string",
        "zdhcId": "string",
        "ipeViolation": {
          "totalViolations": 0
        }
      },
      "account": {
        "_id": "string",
        "name": "string",
        "country": "string",
        "sacId": 0,
        "oar_id": "string",
        "demoaccount": true,
        "vbType": "None",
        "socialCreditId": "string",
        "taxId": "string",
        "bluesignId": "string",
        "zdhcId": "string",
        "ipeViolation": {
          "totalViolations": 0
        }
      },
      "status": "NS",
      "modifiedBy": {
        "_id": "string",
        "email": "string"
      },
      "deletedBy": {
        "_id": "string",
        "email": "string"
      },
      "user": {
        "_id": "string",
        "email": "string"
      },
      "createdOn": 0,
      "deleted": true,
      "modifiedOn": 0
    }
  ]
}