Get projects

You can select project groups in the «Projects» tab of your account. Project groups bring together projects that address a common global problem, for example, «tree planting», «reef restoration» and so on. These groups will be available for your company.

Each group includes a set of projects that correspond to that direction. For example:

Group:

  • Forest restoration

Projects:

  1. Planting 50,000 trees in Indonesia

  2. Growing 10,000 tree seedlings in Kenya

  3. Planting 200,000 mangroves in Florida

  4. Planting 40,000 trees in Thailand

  5. Growing 100,000 tree seedlings in Zambia

  6. ...

We queue projects within the group. Thus, when you make a request and specify the number of projects, you will receive a response in the form of projects that have the highest priority at the moment.

As soon as the project receives the necessary amount of funding, the project team starts its implementation, and the queue moves up one position.

In this way, we create a conveyor system, which allows the project to receive the necessary funding quickly, and the users who support it quickly begin to receive updates about the project's implementation. It also provides a unique experience for users when they make repeat purchases, as projects are updated in your app.

All requests should use https proxy, humance.io domain, and start with /company/integration/. For example https://humance.io/company/integration/orders/make

Endpoint: /get/groups

HEADERS: Authorize your company

API-Key: <Your api key>
API-Secret: <Your api secret key>

GET without any params or set country_code to get projects by priority for your country. Supported formats: form-query;

    {
        // Optional. Set country_code in ISO format to get a project with the highest priority for your country
        "country_code": "US",
        // Optional. Specify the count in integer format to get the number of projects. By default, you will get 4 projects
        "count": 3,
    }

RESPONSE: Status 200 OK


{
    "id": 1,
    "name": "Group name",
    "projects": {
        "id": 31,
        "name": "Project name",
        "status": "published",
        "image": "image url",
        "background_image": "background image url",
        "total_cost": "26229.00",
        "collected_cost": "100.35",
        "percent": "0.38",
        "short_description": "project short description",
        "project_url": "project url",
        "tree_price": "3.25"
    },
},
{
    "id": 2,
    "name": "Group name",
    "projects": {
        "id": 25,
        "name": "Project name",
        "status": "published",
        "image": "image url",
        "background_image": "background image url",
        "total_cost": "59621.00",
        "collected_cost": "0.00",
        "percent": "0.00",
        "short_description": "project short description",
        "project_url": "project url",
        "tree_price": "2.12"
    },
    {
        "id": 26,
        "name": "Project name",
        "status": "published",
        "image": "image url",
        "background_image": "background image url",
        "total_cost": "59621.00",
        "collected_cost": "0.00",
        "percent": "0.00",
        "short_description": "project short description",
        "project_url": "project url",
        "tree_price": "2.12"
    },
    ...
}

You can also display the Humance component to output projects within your application. You can find more information about this in the Component section.

Last updated