Record
1ClickImpact API allows you to make impact by yourself or on behalf of your customers. To query for your records, you can use the /records endpoint. To query for your customers and their impact records, you can use the /customers and /customer_records endpoints.
The user record model
The user record model contains information about your records, such as your id, time of impact request, impact type and amount.
Properties
- Name
user_id- Type
- string
- Description
Unique identifier for yourself.
- Name
time_utc- Type
- string
- Description
The time (in UTC) when the impact request was made.
- Name
tree_planted- Type
- integer
- Description
The number of trees planted.
- Name
waste_removed- Type
- integer
- Description
The amount of ocean waste (in lbs) removed.
- Name
carbon_captured- Type
- integer
- Description
The amount of carbon (in lbs) captured.
- Name
money_donated- Type
- integer
- Description
The amount of money (in smallest USD units) donated for a cause.
- Name
category- Type
- string
- Description
The category of impact. When value is "food", it indicates food-bearing trees that provide nutrition and sustainable income for local communities, and grants access to exclusive live planting sessions.
The customer record model
The customer record model contains information about your customer records, such as your id, customer information, time of impact request, impact type and amount.
Properties
- Name
user_id- Type
- string
- Description
Unique identifier for yourself.
- Name
customer- Type
- Customer
- Description
It contains information about the customer such as customer id, email and name. Please refer to the Customer model for more information.
- Name
time_utc- Type
- string
- Description
The time (in UTC) when the impact request was made.
- Name
tree_planted- Type
- integer
- Description
The number of trees planted.
- Name
waste_removed- Type
- integer
- Description
The amount of ocean waste (in lbs) removed.
- Name
carbon_captured- Type
- integer
- Description
The amount of carbon (in lbs) captured.
- Name
money_donated- Type
- integer
- Description
The amount of money (in smallest USD units) donated for a cause.
- Name
category- Type
- string
- Description
The category of impact. When value is "food", it indicates food-bearing trees that provide nutrition and sustainable income for local communities, and grants access to exclusive live planting sessions.