The Carbon Business API uses API key-based authentication. Every request to the API must include the x-carbon-key header with your API key.

​
Authentication Methods

​
apikey

The apikey is a security scheme used to authenticate requests. It must be included in the request header as authorization. This key is required for all API interactions.

​
x-carbon-key

The x-carbon-key is the header where your app API key is passed. It is mandatory for every request to the Carbon Business API. Without this header, the API will reject the request with an authentication error.

​
How to Get Your API Key

  1. Get in touch with our team via email: sme@getcarbon.co
  2. Sign Up via the sandbox environment Carbon Business developer portal.
  3. Navigate to the Developer menu, Top right Dropdown menu > Developer.
  4. Generate a new CARBON_API_KEY > or use an existing one.
developer

​
Example

Include the apikey header in your requests: 
apikey: YOUR_API_KEY
Include the x-carbon-key header in your requests: 
x-carbon-key: CARBON_API_KEY

​
Example Request

GET /v1/accounts HTTP/1.1
Host: {{BASE_URL}}
apikey: YOUR_API_KEY
x-carbon-key: CARBON_API_KEY

​
Environments

EnvironmentURL
Live[Production URL]
Sandboxhttps://carbonapistagingsecure.getcarbon.co/baas/api