curl --request GET \
--url https://app.variable.global/api/v1/activity/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.variable.global/api/v1/activity/{uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.variable.global/api/v1/activity/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.variable.global/api/v1/activity/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.variable.global/api/v1/activity/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.variable.global/api/v1/activity/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.variable.global/api/v1/activity/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Name",
"created": "2021-01-01T00:00:00.000Z",
"updated": "2021-01-31T23:59:59.000Z",
"syncId": "sync123",
"description": "<string>",
"quantity": 150,
"unit": "kg",
"UpstreamCO2e": "1234",
"DownstreamCO2e": "0.5678",
"product": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Product Name"
},
"scope": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Scope 2: Electricity"
},
"taxonomy": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Material",
"path": "material"
},
"org": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Org Unit"
},
"group": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Business travel"
},
"transportLane": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Shenzhen to Felixstowe"
},
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2021-01-01T00:00:00.000Z",
"CO2e": "1234.5678"
}{
"message": "token expired"
}Get Activity
Get an activity
curl --request GET \
--url https://app.variable.global/api/v1/activity/{uuid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.variable.global/api/v1/activity/{uuid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.variable.global/api/v1/activity/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.variable.global/api/v1/activity/{uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.variable.global/api/v1/activity/{uuid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.variable.global/api/v1/activity/{uuid}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.variable.global/api/v1/activity/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Name",
"created": "2021-01-01T00:00:00.000Z",
"updated": "2021-01-31T23:59:59.000Z",
"syncId": "sync123",
"description": "<string>",
"quantity": 150,
"unit": "kg",
"UpstreamCO2e": "1234",
"DownstreamCO2e": "0.5678",
"product": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Product Name"
},
"scope": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Scope 2: Electricity"
},
"taxonomy": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Material",
"path": "material"
},
"org": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Org Unit"
},
"group": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Business travel"
},
"transportLane": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Shenzhen to Felixstowe"
},
"startDate": "2021-01-01T00:00:00.000Z",
"endDate": "2021-01-01T00:00:00.000Z",
"CO2e": "1234.5678"
}{
"message": "token expired"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Comma-separated activity fields to include in each record, named as they appear in the response (e.g. CO2e, description, supplier). Unknown fields are ignored, and a list naming no known field returns the full record.
"uuid,description,quantity,unit,CO2e"
Response
Activity data
"Name"
ISO 8601 date
"2021-01-01T00:00:00.000Z"
ISO 8601 date
"2021-01-31T23:59:59.000Z"
A description of the activity.
150
The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.
"kg"
if passed, the value will be used instead of the computed value
"1234"
if passed, the value will be used instead of the computed value
"0.5678"
The element the activity buys or sells. A draft or rejected incoming activity takes this element's supplier, even when the element is sent again. A supplier that isn't the element's is rejected: with a 400 on POST and PATCH, and as a failed item in a bulk job's results.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A reference to a taxonomy category, including its machine-readable path.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
One of your company's activity groups, by uuid (see /v1/activity/group). On an update, send null to remove the activity from its group, or leave the field out to keep its group. A value that doesn't carry the uuid of one of your company's groups is rejected: with a 400 on POST and PATCH, and as a failed item in a bulk job's results.
Show child attributes
Show child attributes
One of your company's transport lanes, by uuid (see /v1/transport/lane). On an update, send null to remove the activity's lane, or leave the field out to keep it. A value that doesn't carry the uuid of one of your company's lanes is rejected: with a 400 on POST and PATCH, and as a failed item in a bulk job's results. An activity created with a lane and no unit is recorded in tonnes; an update keeps the activity's unit.
Show child attributes
Show child attributes
ISO 8601 date
"2021-01-01T00:00:00.000Z"
ISO 8601 date
"2021-01-01T00:00:00.000Z"
"1234.5678"