# API Documentation

## Docs

- [Get Account by Email](https://docs.greener-choice.com/api-reference/account/v1/get-carbon-account-by-email.md): To retrieve an account, you can use the `account_email` provided in the response object from the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint.
- [Get Account by Id](https://docs.greener-choice.com/api-reference/account/v1/get-carbon-account-by-id.md): To retrieve an account, you will need the `account_id` provided in the response object from the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint.
- [Get Accounts](https://docs.greener-choice.com/api-reference/account/v1/get-carbon-accounts.md): This will return all carbon accounts that belong to your organisation.
- [Create Account](https://docs.greener-choice.com/api-reference/account/v1/post-carbon-account.md): Carbon accounts are essential for interacting with the Greener Choice API. To receive a quote, place an order, or retrieve carbon orders, you will need an `account_id`.
- [Authentication](https://docs.greener-choice.com/api-reference/authentication.md)
- [Buses](https://docs.greener-choice.com/api-reference/calculator/v1/post-calculate-bus-emissions.md): This endpoint returns an estimated emissions value for the provided parameters for a bus journey.
- [Flights](https://docs.greener-choice.com/api-reference/calculator/v1/post-calculate-flight-emissions.md): This endpoint returns an estimated emissions value for the provided parameters for a flight reservation.
- [Accommodation](https://docs.greener-choice.com/api-reference/calculator/v1/post-calculate-hotel-emissions.md): This endpoint returns an estimated emissions value for the provided parameters for an accommodation reservation.
- [Trains](https://docs.greener-choice.com/api-reference/calculator/v1/post-calculate-train-emissions.md): This endpoint returns an estimated emissions value for the provided parameters for a train journey.
- [Carbon Order Invoice](https://docs.greener-choice.com/api-reference/documents/v1/post-carbon-order-invoice-pdf.md): This endpoint renders a PDF invoice for a carbon order and emails it to the specified email address.
- [Errors](https://docs.greener-choice.com/api-reference/error-handling.md)
- [Getting Started](https://docs.greener-choice.com/api-reference/introduction.md)
- [Get Order By Id](https://docs.greener-choice.com/api-reference/orders/v1/get-carbon-order-by-id.md): This endpoint returns a specific order for an account. To fetch the order, use the `account_id` returned from the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint and the `order_id` returned from the [Create Order](/api-reference/orders/v1-post-carbon-order) endpoint.
- [Get Orders By Account Id](https://docs.greener-choice.com/api-reference/orders/v1/get-carbon-orders-by-account-id.md): This endpoint returns all orders for an account. Use the `account_id` returned by the [Create Account](/api-reference/account/v1-post-carbon-account) endpoint.
- [Cancel Order](https://docs.greener-choice.com/api-reference/orders/v1/post-cancel-carbon-order.md): After creating an order, that order marked as `INITIATED`. While an order is in the `INITIATED` state, the order can be cancelled.
- [Create Order](https://docs.greener-choice.com/api-reference/orders/v1/post-carbon-order.md): After calling [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes), you can create an order for a specific quote using its `quote_id`.
- [Get Portfolios](https://docs.greener-choice.com/api-reference/portfolios/v1/get-carbon-portfolios.md): This endpoint returns all available portfolios from our selected providers. These portfolios are the same as those included in the [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes) response, but are presented here in a more accessible format.
- [Get Portfolios By Provider](https://docs.greener-choice.com/api-reference/portfolios/v1/get-carbon-portfolios-by-provider.md): This endpoint returns all available portfolios from the requested provider. These portfolios are the same as those included in the [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes) response, but are presented here in a more accessible format.
- [Get Quote By Id](https://docs.greener-choice.com/api-reference/quotes/v1/get-carbon-quote-by-id.md): To retrieve a specific quote, you will need the `quote_id` provided by the [Get Quotes](/api-reference/quotes/v1-post-carbon-quotes) endpoint.
- [Get Quotes](https://docs.greener-choice.com/api-reference/quotes/v1/post-carbon-quotes.md): This endpoint requires an emissions value (in kg) and your `account_id`. It returns several quotes from different providers, each including portfolio breakdowns and information on the provider.
- [Request IDs](https://docs.greener-choice.com/api-reference/request-id.md)

## OpenAPI Specs

- [openapi](https://docs.greener-choice.com/api-reference/openapi.json)