API Reference
Log In
API Reference

Account

With the Account endpoints you can manage and fetch top-level resources.

PublicAccount Object

PropertyTypeDescription
namestringThe name of the account.
signupDatestringThe signup date of the account in ISO 8601 format.
accountType'business' | 'personal' | 'family'The type of the account.
impacts(AccountImpact | RelationImpact | TransferredImpact | ImpactActionImpact)[]Defines the impacts of the account segmented by sources. The carbon type impacts are returned in kg scale.
comparisons(CarbonComparison | PlasticComparison | TreeComparison)[]Defines the comparison equivalents of the account's impacts.