Recalculate Employees

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({employee_ids: {}, activity_categories: {}})
};

fetch('https://api.dcycle.io/v2/employees/recalculate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dcycle.io/v2/employees/recalculate"

payload = {
    "employee_ids": {},
    "activity_categories": {}
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.dcycle.io/v2/employees/recalculate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "employee_ids": {},
  "activity_categories": {}
}
'

{
  "employee_ids": {},
  "count": 123,
  "processing_job_ids": {}
}

POST

employees

recalculate

Recalculate Employees

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<x-api-key>',
    'x-organization-id': '<x-organization-id>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({employee_ids: {}, activity_categories: {}})
};

fetch('https://api.dcycle.io/v2/employees/recalculate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dcycle.io/v2/employees/recalculate"

payload = {
    "employee_ids": {},
    "activity_categories": {}
}
headers = {
    "x-api-key": "<x-api-key>",
    "x-organization-id": "<x-organization-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.dcycle.io/v2/employees/recalculate \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-organization-id: <x-organization-id>' \
  --data '
{
  "employee_ids": {},
  "activity_categories": {}
}
'

{
  "employee_ids": {},
  "count": 123,
  "processing_job_ids": {}
}

Recalculate Employees

Enqueue EF-config recalculation for a set of employees’ commuting periods. The endpoint returns 202 Accepted immediately and creates one ProcessingJob per requested activity category.

All employee IDs must belong to the caller’s organization. IDs that don’t match are silently dropped. The service resolves every enabled commuting period (employees_historic) of the owned employees and enqueues them for recalculation.

Request

Headers

string

required

Your API key for authenticationExample: sk_live_1234567890abcdef

string

required

Your organization UUIDExample: ff4adcc7-8172-45fe-9cf1-e90a6de53aa9

Body Parameters

array of strings

required

One or more employee UUIDs to recalculate. Must be non-empty. Maximum 5000 IDs.Example: ["a1b2c3d4-...", "e5f6g7h8-..."]

array of strings

required

Activity categories to recalculate. Must be non-empty. Duplicates are silently deduplicated.Allowed values:

employee_commuting — Scope 3 employee commuting emissions

Example: ["employee_commuting"]

Response

array of strings

UUIDs of the employees that were enqueued (after organization scoping).

integer

Number of employees enqueued.

array of strings

One ProcessingJob UUID per dispatched activity category.

Example

curl -X POST "https://api.dcycle.io/v2/employees/recalculate" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "Content-Type: application/json" \
  -d '{
    "employee_ids": [
      "550e8400-e29b-41d4-a716-446655440000",
      "660e8400-e29b-41d4-a716-446655440001"
    ],
    "activity_categories": ["employee_commuting"]
  }'

import requests
import os

response = requests.post(
    "https://api.dcycle.io/v2/employees/recalculate",
    headers={
        "x-api-key": os.getenv("DCYCLE_API_KEY"),
        "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
        "Content-Type": "application/json",
    },
    json={
        "employee_ids": [
            "550e8400-e29b-41d4-a716-446655440000",
            "660e8400-e29b-41d4-a716-446655440001",
        ],
        "activity_categories": ["employee_commuting"],
    },
)

result = response.json()
print(f"Enqueued {result['count']} employees, jobs: {result['processing_job_ids']}")

const axios = require('axios');

const response = await axios.post(
  'https://api.dcycle.io/v2/employees/recalculate',
  {
    employee_ids: [
      '550e8400-e29b-41d4-a716-446655440000',
      '660e8400-e29b-41d4-a716-446655440001',
    ],
    activity_categories: ['employee_commuting'],
  },
  {
    headers: {
      'x-api-key': process.env.DCYCLE_API_KEY,
      'x-organization-id': process.env.DCYCLE_ORG_ID,
      'Content-Type': 'application/json',
    },
  }
);

console.log(`Enqueued ${response.data.count} employees`);
console.log(`Job IDs: ${response.data.processing_job_ids.join(', ')}`);

Successful Response

{
  "employee_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "660e8400-e29b-41d4-a716-446655440001"
  ],
  "count": 2,
  "processing_job_ids": [
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}

403 Forbidden

Cause: The authenticated user is not a member of the organization

{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}

422 Unprocessable Entity

Cause: Invalid activity category

{
  "detail": "Invalid activity_category: unknown. Allowed: ['employee_commuting']",
  "code": "VALIDATION_ERROR"
}

List Employees

Retrieve employees to find IDs for recalculation

Get Employee

Check updated emissions on a single employee

​Recalculate Employees

​Request

​Headers

​Body Parameters

​Response

​Example

​Successful Response

​Common Errors

​401 Unauthorized

​403 Forbidden

​422 Unprocessable Entity

​Related Endpoints

List Employees

Get Employee

Recalculate Employees

Request

Headers

Body Parameters

Response

Example

Successful Response

Common Errors

401 Unauthorized

403 Forbidden

422 Unprocessable Entity

Related Endpoints