List Workforce Remunerations
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/own_workforce_remunerations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/own_workforce_remunerations"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/own_workforce_remunerations \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"id": "<string>",
"start_date": "<string>",
"end_date": {},
"amount": 123,
"unit": "<string>"
}List Workforce Remunerations
Retrieve the salary records attached to one workforce contract, with amount and currency
GET
/
v1
/
own_workforce_remunerations
List Workforce Remunerations
const options = {
method: 'GET',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/own_workforce_remunerations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/own_workforce_remunerations"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.get(url, headers=headers)
print(response.text)curl --request GET \
--url https://api.dcycle.io/v1/own_workforce_remunerations \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'{
"id": "<string>",
"start_date": "<string>",
"end_date": {},
"amount": 123,
"unit": "<string>"
}← Own Workforce API
Return the remuneration records of one contract: how much, in which currency, and over which period. This is the only endpoint that exposes individual salary amounts.
Individual pay is among the most sensitive data in the product. Restrict the API keys that can reach this endpoint, and do not write responses to shared logs or caches.
There is no organization-wide salary list. Reading every salary means walking employees → contracts → remunerations, one request per contract. If you want totals, averages or the gender pay gap, do not walk this tree: query the
own_workforce_remuneration dataset through Query datasets, which computes them server-side and segments by gender, country, nationality, job category and age.Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faQuery Parameters
string
required
Contract UUID, from List Workforce ContractsExample:
own_workforce_contract_id=7c9e6679-7425-40de-944b-e07fc1f90ae7Response
A bare JSON array of remuneration records.string
Remuneration UUID
string
First day the amount applies,
YYYY-MM-DDstring | null
Last day it applies. Null means it is still current.
number
The gross pay for the remuneration’s period, from
start_date to end_date, as it was loaded.string
Currency, resolved to its unit name — for example
euros_(eur), us_dollar_(usd), mexican_peso_(mxn). Amounts are not converted to a common currency, so do not sum across records without converting first.Example
curl -X GET "https://api.dcycle.io/v1/own_workforce_remunerations?own_workforce_contract_id=7c9e6679-7425-40de-944b-e07fc1f90ae7" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}"
import os
import requests
headers = {
"x-api-key": os.getenv("DCYCLE_API_KEY"),
"x-organization-id": os.getenv("DCYCLE_ORG_ID"),
}
response = requests.get(
"https://api.dcycle.io/v1/own_workforce_remunerations",
headers=headers,
params={"own_workforce_contract_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"},
)
records = response.json()
# Do not print individual pay. Aggregate, or carry the values straight to their destination.
print(f"{len(records)} remuneration periods on this contract")
const axios = require('axios');
const headers = {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID
};
axios.get('https://api.dcycle.io/v1/own_workforce_remunerations', {
headers,
params: { own_workforce_contract_id: '7c9e6679-7425-40de-944b-e07fc1f90ae7' }
})
.then(response => {
// Do not log individual pay. Aggregate, or carry the values straight to their destination.
console.log(`${response.data.length} remuneration periods on this contract`);
})
.catch(error => console.error(error));
Successful Response
[
{
"id": "b1e2d3c4-5f60-4a71-8b92-0c1d2e3f4a5b",
"start_date": "2023-06-01",
"end_date": "2024-12-31",
"amount": 42000.0,
"unit": "euros_(eur)"
},
{
"id": "c2f3e4d5-6071-4b82-9ca3-1d2e3f4a5b6c",
"start_date": "2025-01-01",
"end_date": null,
"amount": 45500.0,
"unit": "euros_(eur)"
}
]
Common Errors
401 Unauthorized
Cause: the key is invalid or revoked (INVALID_API_KEY), expired (API_KEY_EXPIRED), belongs neither to the organization in x-organization-id nor to one of its parents (API_KEY_ORG_MISMATCH), or has no owner (API_KEY_NO_OWNER). A request carrying no credentials at all answers AUTHENTICATION_REQUIRED. See Errors.
{
"detail": "Invalid API key for organization",
"code": "INVALID_API_KEY"
}
403 Forbidden
Cause: the key’s owner is not an enabled member of the organization inx-organization-id.
{
"detail": "Logged User is not Member of Organization",
"code": "LOGGED_USER_NOT_MEMBER"
}
404 Not Found
Cause: no contract with that id inside your perimeter. The contract is resolved through its employee to an organization, so another tenant’s salaries are a 404 rather than a readable list.{
"code": "NOT_FOUND",
"detail": "OwnWorkforceContractModel with id='550e8400-e29b-41d4-a716-446655440000' not found"
}
422 Unprocessable Entity
Cause:own_workforce_contract_id missing or not a UUID.
{
"detail": [
{
"type": "missing",
"loc": ["query", "own_workforce_contract_id"],
"msg": "Field required"
}
]
}
Related Endpoints
List contracts
Where the contract id comes from
Query datasets
Averages and the gender pay gap, computed server-side
Was this page helpful?