Delete Workforce Employee
const options = {
method: 'DELETE',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/own_workforces/{own_workforce_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/own_workforces/{own_workforce_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.delete(url, headers=headers)
print(response.text)curl --request DELETE \
--url https://api.dcycle.io/v1/own_workforces/{own_workforce_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'Delete Workforce Employee
Permanently delete one own workforce employee and the records that hang off them
DELETE
/
v1
/
own_workforces
/
{own_workforce_id}
Delete Workforce Employee
const options = {
method: 'DELETE',
headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};
fetch('https://api.dcycle.io/v1/own_workforces/{own_workforce_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/own_workforces/{own_workforce_id}"
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>"
}
response = requests.delete(url, headers=headers)
print(response.text)curl --request DELETE \
--url https://api.dcycle.io/v1/own_workforces/{own_workforce_id} \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>'← Own Workforce API
Delete a single employee. This is irreversible, and there is no endpoint that creates one back — the only way to restore an employee is to re-import them through the Imports API.
Deleting an employee removes the records that depend on them: contracts, remunerations, trainings and absence/accident records. Their reported headcount, FTE and training hours change accordingly for every period they appeared in.
Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faPath Parameters
string
required
Employee UUIDExample:
550e8400-e29b-41d4-a716-446655440000Response
204 No Content with an empty body.
Example
curl -X DELETE "https://api.dcycle.io/v1/own_workforces/550e8400-e29b-41d4-a716-446655440000" \
-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"),
}
employee_id = "550e8400-e29b-41d4-a716-446655440000"
response = requests.delete(
f"https://api.dcycle.io/v1/own_workforces/{employee_id}",
headers=headers,
)
print(response.status_code) # 204
const axios = require('axios');
const headers = {
'x-api-key': process.env.DCYCLE_API_KEY,
'x-organization-id': process.env.DCYCLE_ORG_ID
};
const employeeId = '550e8400-e29b-41d4-a716-446655440000';
axios.delete(`https://api.dcycle.io/v1/own_workforces/${employeeId}`, { headers })
.then(response => console.log(response.status))
.catch(error => console.error(error));
Common Errors
401 Unauthorized
Cause: the key is invalid, or it does not belong to the organization inx-organization-id — the two are looked up as a pair. A request carrying no credentials at all answers AUTH_REQUIRED instead.
{
"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, or the key’s role cannot write.
{
"detail": "Logged User is not Member of Organization",
"code": "LOGGED_USER_NOT_MEMBER"
}
404 Not Found
Cause: no employee with that id inside your perimeter. A row owned by an organization outside the header organization’s accepted family answers 404, never 403.{
"code": "NOT_FOUND",
"detail": "OwnWorkforceModel with id='550e8400-e29b-41d4-a716-446655440000' not found"
}
Related Endpoints
Bulk delete employees
Delete up to 100,000 by id
Bulk delete by filters
Delete everything a filtered list returned
Was this page helpful?