Bulk Delete Vehicles by Filters

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

fetch('https://api.dcycle.io/v1/vehicles/bulk-delete-by-filters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success_count": 123,
  "success_ids": {},
  "failed_count": 123,
  "failed_ids": {},
  "message": "<string>"
}

POST

vehicles

bulk-delete-by-filters

Bulk Delete Vehicles by Filters

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

fetch('https://api.dcycle.io/v1/vehicles/bulk-delete-by-filters', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success_count": 123,
  "success_ids": {},
  "failed_count": 123,
  "failed_ids": {},
  "message": "<string>"
}

Bulk Delete Vehicles by Filters

Delete all vehicles that match a set of filter criteria. This endpoint uses a two-step workflow: first fetch the vehicle list with filters applied (which returns a filter_hash), then call this endpoint with that hash to confirm you are deleting exactly what you saw.

Permanent Action: Deleting vehicles is permanent and cannot be undone. All associated consumption records and emissions data will be removed from your organization’s totals.

How It Works

Call GET /v1/vehicles with your desired filters — the response includes a filter_hash field.
Call this endpoint with the same query filters and pass the filter_hash in the request body.
The API verifies the hash matches the current filter results to prevent stale-data race conditions.

Request

Headers

x-api-key

string

required

Your API key for authenticationExample: sk_live_1234567890abcdef

x-organization-id

string

required

Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Body Parameters

filter_hash

string

required

The hash returned in the filter_hash field of the vehicle list response. Confirms you are deleting exactly the records you saw.Example: "a3f1c2e4b5d6a7b8"

Query Parameters

At least one filter parameter is required.

string

Text search across vehicle fields (e.g. license plate, name)

status[]

array[string]

Filter by vehicle statusAvailable values: active, archived, errorExample: status[]=active&status[]=archived

ownership[]

array[string]

Filter by vehicle ownership typeAvailable values: owned, rentedExample: ownership[]=owned

unknown_vehicle_id[]

array[string]

Filter by unknown vehicle UUIDs

vehicle_fuel_id[]

array[string]

Filter by fuel type UUIDs

file_id[]

array[string]

Filter by source file UUIDs (e.g. to delete all vehicles imported from a specific file)

created_at_from

string

Filter vehicles created on or after this datetime (ISO 8601)Example: 2024-01-01T00:00:00Z

created_at_to

string

Filter vehicles created on or before this datetime (ISO 8601)Example: 2024-12-31T23:59:59Z

include_children

boolean

default:"false"

Include vehicles from child organizations

Response

Returns 200 OK with a JSON summary of the operation.

success_count

integer

Number of vehicles successfully deleted

success_ids

array[string]

UUIDs of successfully deleted vehicles

failed_count

integer

Number of vehicles that failed to delete

failed_ids

array[string]

UUIDs of vehicles that failed to delete

message

string

Human-readable summary of the operation

Example

# Step 1: get list with filters to obtain filter_hash
curl -X GET "https://api.dcycle.io/v1/vehicles?status[]=archived&file_id[]=880e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

# Step 2: bulk delete using the filter_hash from the list response
curl -X POST "https://api.dcycle.io/v1/vehicles/bulk-delete-by-filters?status[]=archived&file_id[]=880e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}" \
  -H "Content-Type: application/json" \
  -d '{"filter_hash": "a3f1c2e4b5d6a7b8"}'

Successful Response

{
  "success_count": 15,
  "success_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "660e8400-e29b-41d4-a716-446655440001"
  ],
  "failed_count": 0,
  "failed_ids": [],
  "message": "Successfully deleted 15 vehicles"
}

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

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

409 Conflict — Filter Hash Mismatch

Cause: The filter_hash does not match the current filter results. The underlying data changed between the list call and the delete call.

{
  "detail": "Filter hash mismatch. The filters have changed since the list was loaded. Please refresh and try again."
}

Solution: Re-fetch the vehicle list with the same filters to get a fresh filter_hash, then retry.

422 Unprocessable Entity — No Filters Provided

Cause: No filter query parameters were supplied. At least one filter is required to prevent accidental mass deletion.

{
  "detail": "At least one filter parameter is required for bulk delete by filters."
}

422 Validation Error

Cause: Invalid query parameter value (e.g. unknown status enum)

{
  "detail": [
    {
      "loc": ["query", "status[]"],
      "msg": "value is not a valid enumeration member; permitted: 'active', 'archived', 'error'",
      "type": "type_error.enum"
    }
  ]
}

List Vehicles

Retrieve vehicles and obtain the filter_hash