Getting API Access

Most of Scope3's APIs are restricted to customers with a valid API key. To obtain access, please contact your Scope3 representative. In the future, Scope3 will provide mechanisms for customers to manage their own API Access Tokens more easily.

Access Tokens

Access tokens allow automated systems and applications to authenticate and access the Scope3 API. These tokens are generated by Scope3 and are of the format scope3_accessClientId_accessClientSecret.

Scope3 expects this value to be passed as HTTP headers on every request.

Example HTTP Request

curl --request POST 
     --url https://api.scope3.com/v2/measure 
     --header 'accept: application/json' 
     --header 'authorization: Bearer scope3_accessClientId_accessClientSecret'
     --header 'content-type: application/json' 

Updating a V1 API token for use with V2

You can create a V2 access token with your V1 credentials by combining your existing accessClientId and accessClientSecret in the following format — scope3_accessClientId_accessClientSecret.

For example, using a specific example where your accessClientId was: "l3gjkul53te" and accessClientSecret was "cC5ytfk6Gb9naLlPvXuI912Y9WijC1fZXHZKV6dIefRCOE9bbxjmK", our final key will then look something like the following: scope3_l3gjkul53te_cC5ytfk6Gb9naLlPvXuI912Y9WijC1fZXHZKV6dIefRCOE9bbxjmK