dots.eco icon

dots.eco

Work with dots.eco API. Rewarding you for casually saving the planet.

Allocation → List

AI-generated

Overview

This node interacts with the dots.eco API to list allocations for a specified company. It is useful for retrieving allocation data related to environmental or sustainability efforts tracked by dots.eco, such as carbon offset allocations or other resource allocations associated with a company. For example, a user can input a company ID to get a list of all allocations for that company, optionally localizing the allocation labels and descriptions by specifying a language code.

Use Case Examples

  1. List all allocations for a company by providing the company ID.
  2. Retrieve localized allocation information by specifying a language code.

Properties

Name Meaning
Company ID The unique identifier of the company for which allocations are to be listed. This is a required numeric input with a minimum value of 1.
Language Optional language code to localize allocation labels and descriptions. The options are loaded dynamically from supported languages by dots.eco.

Output

JSON

  • json - The JSON output contains the allocation data retrieved from the dots.eco API, structured as an array of allocation objects.

Dependencies

  • Requires an API key credential for dots.eco API authentication.

Troubleshooting

  • Common issues include providing an invalid or missing company ID, which will cause the API request to fail.
  • If the language code is invalid or unsupported, localization may not work as expected, but the API should still return default allocation data.
  • Errors from the API are caught and returned as error messages in the output if 'Continue On Fail' is enabled; otherwise, they cause the node to fail with an error.

Discussion