Get events of a car

GET

/cars/{carId}/events

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

Purpose

Retrieve open and close events for one specific car in the selected customer context.

An event represents an open or close event of a car.

Use this operation when the partner backend needs to read the event history of a car for operational visibility, audit views, support diagnostics or reconciliation.

Events are read-only records in normal partner workflows.

This operation does not create access rights.

This operation does not unlock or lock a vehicle.

This operation does not change assignments.

When to use this operation

Use this operation when the partner backend needs to retrieve car event history.

Typical situations:

showing car open and close history in an operational backend,
investigating support cases,
reconciling expected car usage with recorded open and close events,
auditing access activity for a specific car,
retrieving event data for reporting,
checking whether an expected car open or close event was recorded.

The source documentation explicitly warns that returned data should always be limited using OData.

For production integrations, always use appropriate OData query options to limit result size.

For standard access flows, partner backends usually work primarily with Car, User and Assignment.

Events are operational records and should not be treated as the primary access permission model.

Access permissions are managed through assignments between User and Car.

Validation notes

The base request returned 200 OK with a direct JSON array.
$top, $skip, $orderby=utcDateTime desc and $filter=type eq 'CarClosed' were validated successfully.
Explicit ordering is required for deterministic pagination. Event IDs do not necessarily reflect chronological order.
The observed type values included CarOpened, CarClosed and an empty string. Partner implementations must handle unknown or empty values.
dateTime represented local wall-clock time but ended in Z; utcDateTime represented the corresponding UTC value. Use utcDateTime for ordering and time calculations.
latitude and longitude were returned as numbers in existing records and as null for the created validation event.

Async behavior

Synchronous.

The result is represented by 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.

Event data can contain operational access history.

Treat event records as sensitive operational data.

Group, car, user and event identifiers are environment-specific.

Do not mix UAT and PROD IDs.

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

For standard partner integrations, the mobile app must not receive API Manager credentials, backend bearer tokens or the flinkey-API-Key.

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

Events of the car were retrieved successfully

application/json

Array<object>

object

Database ID of the event

dateTime

Event date and time

utcDateTime

Event date and time in UTC

userId

Database ID of the user associated with the event

carId

Database ID of the car associated with the event

type

Event type. Observed values include CarOpened, CarClosed and an empty string; clients must tolerate unknown or empty values

userAgent

User agent recorded for the event

latitude

Latitude of the event, if available

longitude

Longitude of the event, if available

Example

[
  {
    "id": 12345,
    "dateTime": "2026-07-01T10:15:30.000",
    "utcDateTime": "2026-07-01T08:15:30.000Z",
    "userId": 67890,
    "carId": 123,
    "type": "CarOpened",
    "userAgent": "partner-backend",
    "latitude": 51.2562,
    "longitude": 7.1508
  }
]

401

Invalid subscription key or missing / invalid access token

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

404

API Manager was not found for the given OAuth ID claim data

Recommended handling: Check credentials, token context and API Manager configuration

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent