Skip to main content
GET
Get an activity by UUID
Requires permission: activity:read
Read more about the Activity data models.

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

return
string

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.

Example:

"uuid,description,quantity,unit,CO2e"

Response

Activity data

uuid
string<uuid>
name
string
Example:

"Name"

created
string

ISO 8601 date

Example:

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

updated
string

ISO 8601 date

Example:

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

syncId
string

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

Example:

"sync123"

description
string

A description of the activity.

quantity
number
Example:

150

unit
string

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

Example:

"kg"

UpstreamCO2e
string

if passed, the value will be used instead of the computed value

Example:

"1234"

DownstreamCO2e
string

if passed, the value will be used instead of the computed value

Example:

"0.5678"

product
object

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.

scope
object
taxonomy
object

A reference to a taxonomy category, including its machine-readable path.

org
object
group
object | null

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.

transportLane
object | null

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.

startDate
string

ISO 8601 date

Example:

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

endDate
string

ISO 8601 date

Example:

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

CO2e
string
Example:

"1234.5678"