Get product

GET

/products/{productId}

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

Purpose

Retrieve one specific product by product ID in the selected customer context.

A product represents a flinkey hardware product assigned to the customer context.

In standard developer integrations, partner backends usually work primarily with Car, User and Assignment.

Use this operation for operational lookup, reconciliation and support workflows where product-level information is required.

When to use this operation

Use this operation when the partner backend needs to retrieve one specific product.

Typical situations:

validating a product reference,
checking product serial number,
checking product SAP number,
identifying product type,
troubleshooting vehicle or box setup,
reconciling hardware information with partner or support records.

Do not treat Product as the primary access permission object.

Access permissions are managed through assignments between User and Car.

Validation notes

The base request returned 200 OK with one product object matching the product collection entry.
The response included the additional carId field.
dongleTerminationTimeStamp is a legacy response field from the former virtual Geotab dongle connection. That functionality is no longer supported; the field has no current integration meaning and must not drive business logic.
Collection-style OData options returned 400 Bad Request because the resource is not a collection.

Async behavior

Synchronous.

The product 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.

Product identifiers are environment-specific.

Do not mix UAT and PROD product 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

productId

required

number

Database ID of the product

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Product was retrieved successfully

application/json

object

Product database ID

number

uniqueId

Unique product identifier

string

serialNumber

Product serial number

string

sapNumber

SAP number

string

dongleTerminationTimeStamp

Functionally obsolete legacy field from the former virtual telematics-dongle connection; do not use for integration logic

string | null

type

Product type, for example flinkey Box or flinkey IQ

string

carId

Database ID of the assigned car, or null when no car is assigned

number | null

Example

{
  "id": 67890,
  "uniqueId": "PU-2024-00001",
  "serialNumber": "SN-100200300",
  "sapNumber": "SAP-400500",
  "dongleTerminationTimeStamp": null,
  "type": "flinkey Box",
  "carId": 123
}

401

Invalid subscription key or missing / invalid access token

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

404

API Manager, customer context or product was not found

Recommended handling: Check credentials, Customer-ID and local productId reference

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent