GET
/
v1
/
switch
curl --request GET \
  --url https://app.variable.global/api/v1/switch \
  --header 'Authorization: Bearer <token>'
[
  {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "syncId": "sync123",
    "name": "Switch Name",
    "unit": "kg",
    "image": "https://app.variable.global/uploads/image.jpg",
    "sources": [
      {
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Name"
      }
    ],
    "footprint": {
      "CO2e": {
        "productCarbonFootprint": "1234.5678",
        "A1_A3": "1234.5678"
      }
    },
    "created": "2021-01-01T00:00:00.000Z",
    "updated": "2021-01-31T23:59:59.000Z"
  }
]
Requires permission:

Read more about the Switch data model.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json
A list of Switches
​
created
string

ISO 8601 date

Example:

"2021-01-01T00:00:00.000Z"

​
updated
string

ISO 8601 date

Example:

"2021-01-31T23:59:59.000Z"

​
uuid
string
​
syncId
string

An identifier to use when syncing data with other systems

Example:

"sync123"

​
name
string
Example:

"Switch Name"

​
unit
string

The unit code (e.g. kg, lbs, etc.). All unit codes can be found in the List Units endpoint.

Example:

"kg"

​
image
string
Example:

"https://app.variable.global/uploads/image.jpg"

​
sources
object[]
​
footprint
object