A collection of requests that can be made to the Treepoints API
\nThe base url for Staging is staging-api.treepoints.green
The base url for Production is api.treepoints.green
Step 1:
\nStep 2:
\nStep 3 (optional):
\nStep 4:
\nStep 5 (optional):
\nErrors will be returned with the following format:
\n{\n \"error_id\": \"EMAIL_ALREADY_EXISTS\",\n \"message\": \"A user with the email address 'luke+treepointslocal1@stasher.com' already exists\",\n \"errors\": {}\n}\n\nerror_id is the unique key for the error
message is a description of the problem
errors can contain extra information about the error. For example in a validation error you will see which fields need fixing, for example:
{\n \"error_id\": \"INVALID_DATA\",\n \"message\": \"Bad request - please consult the API documentation\",\n \"errors\": {\n \"email\": [\n \"Missing data for required field.\"\n ],\n \"password\": [\n \"Missing data for required field.\"\n ]\n }\n}\n\nGeneral errors:
\nINVALID_TOKEN - You've provided an expired, malformed or otherwise invalid token. You should request a new one and try again.
Register an account using this endpoint.
\nEMAIL_ALREADY_EXISTS a user with this email already exists
COMPANY_ALREADY_EXISTS a company with this name already exists
INVALID_PASSWORD the password chosen has fewer than 10 characters
Used to log into a user account and receive a token
\nINCORRECT_CREDENTIALS the credentials provided are incorrect
can provide an optional expires_at argument to generate a token with an expiry time. Times are in UTC
Use this endpoint to expire an existing token
\n","urlObject":{"path":["auth","logout"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"6e664fad-39a7-481b-9da9-6206e3871135","name":"Log out","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token {{auth_token}}","type":"text"}],"url":"{{url}}/auth/logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Tue, 25 Oct 2022 16:28:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Set-Cookie","value":"session_id=a4aab021-3a62-41de-9810-9246b3c22b09; Path=/"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully logged out.\",\n \"status\": \"success\"\n}"}],"_postman_id":"60a4132e-1bc1-40b6-9770-7107fdbea484"},{"name":"Forgot Password","id":"4670ea7e-d008-4187-85b1-81909accaa2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"{{email}}\"\n}"},"url":"{{url}}/auth/forgot-password","description":"Hit this endpoint to receive a password reset email with a code you will need to reset your password.
\nUSER_NOT_FOUND a user with the email provided could not be found
Use this endpoint to submit your code and new password.
\nUSER_NOT_FOUND a user with the email provided could not be found
INVALID_PASSWORD the password chosen has fewer than 10 characters
INVALID_RESET_CODE the reset code provided is invalid
Hit this endpoint to expire all tokens for the user associated with your token
\n","urlObject":{"path":["auth","expire-all-tokens"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"647a9093-3740-4591-b249-215048ee5057","name":"Expire All Tokens","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Token {{auth_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/auth/expire-all-tokens"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Thu, 17 Nov 2022 16:07:53 GMT"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"76"},{"key":"Set-Cookie","value":"session_id=c651a09a-df73-41cc-8acf-85768cad6b45; Path=/"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully expired all tokens.\",\n \"status\": \"success\"\n}"}],"_postman_id":"b73a07e2-08d7-4bf6-b1d5-b4cfc6d73662"},{"name":"Status","id":"9c9e7eb7-ac5f-46b0-bf7d-9898e5b652e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{auth_token}}","type":"text"}],"url":"{{url}}/auth/status","description":"Check the status of an auth token
\n","urlObject":{"path":["auth","status"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"515a1ce8-7cef-4cb6-bdb4-f35d872e6478","name":"Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{auth_token}}","type":"text"}],"url":"{{url}}/auth/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Thu, 27 Oct 2022 02:40:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"87"},{"key":"Set-Cookie","value":"session_id=a4aab021-3a62-41de-9810-9246b3c22b09; Path=/"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"luke+treepointsexample@stasher.com\",\n \"id\": \"594beaf3ff8641f0b64efc6ccc664ed0\"\n}"}],"_postman_id":"9c9e7eb7-ac5f-46b0-bf7d-9898e5b652e9"}],"id":"3db21f1f-c431-4596-9f15-eef0bde1cb22","_postman_id":"3db21f1f-c431-4596-9f15-eef0bde1cb22","description":""},{"name":"Offset","item":[{"name":"Get offsets data","id":"81288043-92e2-43c2-a5c3-d2be952b2f3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Token {{auth_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/offset","description":"Get a list of all offsets for your user. You can also filter these by the optional query parameters.
\n","urlObject":{"path":["offset"],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"Admins only.
\n","type":"text/plain"},"key":"user_id","value":"{string}"},{"disabled":true,"description":{"content":"Either \"carbon\", \"tree\" or \"plastic\".
\n","type":"text/plain"},"key":"product","value":"{string}"},{"disabled":true,"description":{"content":"All offsets on or before this datetime.
\n","type":"text/plain"},"key":"created_lte","value":"{datetime}"},{"disabled":true,"description":{"content":"All offsets on or after this datetime.
\n","type":"text/plain"},"key":"created_gte","value":"{datetime}"},{"disabled":true,"description":{"content":"Admins only. Either \"api_integration\", \"shopify_subsidized\" or \"shopify_opt_in\".
\n","type":"text/plain"},"key":"source_of_sale","value":"{string}"},{"disabled":true,"description":{"content":"Admins only.
\n","type":"text/plain"},"key":"currency_code_of_sale","value":"{string}"}],"variable":[]}},"response":[{"id":"e39f54cc-e471-4292-bec4-8508870406e3","name":"Get offsets data","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Token {{auth_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url}}/offset","host":["{{url}}"],"path":["offset"],"query":[{"key":"user_id","value":"{string}","description":"Admins only.","disabled":true},{"key":"product","value":"{string}","description":"Either \"carbon\", \"tree\" or \"plastic\".","type":"text","disabled":true},{"key":"created_lte","value":"{datetime}","description":"All offsets on or before this datetime.","disabled":true},{"key":"created_gte","value":"{datetime}","description":"All offsets on or after this datetime.","type":"text","disabled":true},{"key":"source_of_sale","value":"{string}","description":"Admins only. Either \"api_integration\", \"shopify_subsidized\" or \"shopify_opt_in\".","type":"text","disabled":true},{"key":"currency_code_of_sale","value":"{string}","description":"Admins only.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"gunicorn/20.0.4"},{"key":"Date","value":"Thu, 27 Oct 2022 02:41:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"184"},{"key":"Set-Cookie","value":"session_id=a4aab021-3a62-41de-9810-9246b3c22b09; Path=/"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"has_next\": false,\n \"has_prev\": false,\n \"items\": [\n {\n \"amount\": 1,\n \"created\": \"2022-10-27T02:40:39.512652\",\n \"id\": \"d0b7646c27564897962a5b5f86d07bce\",\n \"product\": \"tree\"\n }\n ],\n \"page\": 1,\n \"pages\": 1,\n \"total\": 1\n}"}],"_postman_id":"81288043-92e2-43c2-a5c3-d2be952b2f3a"},{"name":"Purchase Carbon Offsetting","id":"bda75dcb-dde6-4f00-8c4e-4b899386ab20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Token {{auth_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1,\n \"product\": \"tree\",\n \"idempotency_key\": \"some_unique_identifier\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/offset","description":"Use this to purchase a carbon offsetting product. This can be a tree, a kg of carbon, a plastic bottle, or a monetary value of carbon offsetting in your chosen currency.
\nYour request should be authenticated with a token, and the purchase will be made on behalf of that user.
\n`amount`: Required, the amount of carbon offsetting to purchase, in minor denominations. Must be an Integer\n`product`: Required, the product to purchase. Must be one of ['TREE', 'CARBON', 'PLASTIC', 'GBP', 'USD', 'EUR']\n`idempotency_key`: Optional, add an idempotency_key to allow you to safely retry requests. Must be a String\n\nTree purchases are per tree
\nCarbon purchases are per kg
\nPlastic purchases are per plastic bottle
\nCurrency purchases are per minor denomination, so to offset £1.00 you must send an amount of 100
\nAdding one of these to your request will mean your request is checked. We will check if another request with your idempotency_key exists for your user_id. If it does then no purchase will be made since we deem the purchase to have already been made previously. This allows you to safely retry failed requests without risk of a double purchase.
\nIDEMPOTENCY_USED the idempotency key has already been used
INVALID_PRODUCT the product is not supported
INVALID_AMOUNT the amount provided must not be 0 and must be an integer
INVALID_COST the cost at sale provided must not be None or less than or equal to 0
CURRENCY_NOT_FOUND the currency provided could not be found
USER_NOT_FOUND a user with the id provided could not be found
USER_RESTRICTED the user is restricted from making purchases
A collection of endpoints for managing treepoints
\n","_postman_id":"1fc7f645-7baf-4dd3-82ad-8bc968ecf820"},{"name":"Companies","item":[{"name":"Create Company","id":"6336eeae-8fac-45c4-858d-ae810208c0c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token {{auth_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Company\",\n \"opted_in\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/companies","description":"UNAUTHORIZED the user must be an admin to create a company for another user
USER_NOT_FOUND a user with the id provided could not be found
COMPANY_ALREADY_EXISTS a company with the name provided already exists
COMPANY_WITH_USER_ID_ALREADY_EXISTS a company with the user_id provided already exists