Get cars

GET

/cars

const url = 'https://api-uat.flinkey.de/v3/cars';
const options = {
  method: 'GET',
  headers: {
    'Customer-ID': 'example',
    'flinkey-API-Key': '<flinkey-API-Key>',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-uat.flinkey.de/v3/cars \
  --header 'Authorization: Bearer <token>' \
  --header 'Customer-ID: example' \
  --header 'flinkey-API-Key: <flinkey-API-Key>'

Purpose

Retrieve cars available in the selected customer context.

A car represents the vehicle access object used by the flinkey API.

For developer integrations, the flinkey BLE Box is abstracted behind the Car concept.

The returned car IDs can be used to create, update, inspect or assign access to cars.

When to use this operation

Use this operation when the partner backend needs to retrieve or search existing cars.

Typical situations:

initial integration setup,
checking whether a car already exists before creating a new one,
validating the local mapping between partner vehicles and flinkey cars,
troubleshooting assignment creation,
reconciling partner vehicle records with flinkey car records.

In most integrations, the partner backend should persist a mapping between the partner vehicle ID and the flinkey carId.

Validation notes

PROD validation result:

GET /cars was successfully executed with flinkey-API-Key, Authorization: Bearer {{accessToken}} and Customer-ID.
The response is an array.
id is returned as number.
description, vin, licensePlate, brand and model can contain empty strings, whitespace-only values, test/setup-specific values or null depending on the field and vehicle setup.
$top is supported.
$skip is supported.
$filter is supported.
$orderby is supported.
$select is not supported; using $select returns no result.

Async behavior

Synchronous.

The cars are returned directly in the API response.

Webhook result

No.

This operation does not produce a webhook result.

Security notes

Never log:

flinkey-API-Key,
bearer token,
full request headers.

Car identifiers are environment-specific.

Do not mix UAT and PROD car IDs.

Use placeholders in documentation, examples, screenshots and AI prompts.

Authorizations

apiKey
bearerAuth

Parameters

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Cars were retrieved successfully

application/json

Array<object>

object

Car database ID

number

name

Car name

string

description

Optional car description

string | null

vin

Vehicle identification number

string | null

licensePlate

Vehicle license plate

string | null

brand

Vehicle brand

string | null

model

Vehicle model

string | null

Example

[
  {
    "id": 12345,
    "name": "VW Golf Fleet-01",
    "description": "White VW Golf, 2024",
    "vin": "WVWZZZ1KZXW000001",
    "licensePlate": "B-FL 1234",
    "brand": "Volkswagen",
    "model": "Golf"
  }
]

401

Invalid subscription key or missing / invalid access token

Recommended handling: Check flinkey-API-Key, bearer token and environment configuration

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent