Skip to main content
GET
Get a Switch by UUID
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.

Path Parameters

uuid
string<uuid>
required

Query Parameters

impacts
string

Which environmental impact indicators to include in the impacts field. Absent or empty returns only GWP-fossil. Pass all for every indicator, or a comma-separated list of canonical codes to filter (case-insensitive). all is only honored on its own — combining it with other codes (e.g. all,gwp-fossil) is treated as an unknown code. An unknown code returns 400. See the Impacts concept and the full indicator catalog.

Example:

"gwp-fossil,odp,ap"

Response

A Switch

uuid
string<uuid>
syncId
string

An identifier to use when syncing data with other systems. Read more

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
deprecated

Deprecated — use impacts["GWP-fossil"]. Kept for backwards compatibility.

impacts
object

Environmental impact indicators keyed by canonical code (e.g. GWP-fossil, ODP, AP). Which indicators appear is controlled by the impacts query parameter — by default only GWP-fossil is returned.

Example:
created
string

ISO 8601 date

Example:

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

updated
string

ISO 8601 date

Example:

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