Get car

GET

/cars/{carId}

const url = 'https://api-uat.flinkey.de/v3/cars/1';
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/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Customer-ID: example' \
  --header 'flinkey-API-Key: <flinkey-API-Key>'

Purpose

Retrieve one specific car by car ID 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.

Use this operation when the partner backend already knows the flinkey carId and needs to retrieve the current car data.

When to use this operation

Use this operation when the partner backend needs to inspect or validate one specific car.

Typical situations:

validating a stored partner vehicle to flinkey car mapping,
checking whether a stored carId still exists,
retrieving car metadata before creating an assignment,
troubleshooting assignment creation,
reconciling local vehicle data with flinkey car data.

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/{carId} was successfully executed with flinkey-API-Key, Authorization: Bearer {{accessToken}} and Customer-ID.
The response is a single car object.
id is returned as number.
description, vin, name, licensePlate, brand and model are returned as string values.
Metadata fields such as vin may be empty depending on vehicle setup and data quality.
OData collection query options such as $filter, $orderby, $count, $skip and $top are not supported because this endpoint returns a single resource, not a collection.
$select was tested and resulted in a timeout; do not use $select for this endpoint.
Use GET /cars for OData-based filtering, ordering, paging or collection query behavior.

Async behavior

Synchronous.

The car is 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

Path Parameters

carId

required

integer

Database ID of the car

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Car was retrieved successfully

application/json

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": 123,
  "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

404

API Manager or requested car could not be found for the selected customer context

Recommended handling: Check API Manager setup, Customer-ID, carId and local vehicle mapping

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent