Get products

GET

/products

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

Purpose

Retrieve products available 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 product operations 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 or search products assigned to the selected customer context.

Typical situations:

operational support,
hardware reconciliation,
checking which products are available for a customer,
identifying product serial numbers,
relating products to cars or services,
troubleshooting vehicle or box setup.

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 a direct JSON array.
$top, $skip, $orderby=id desc and $filter=id eq {productId} were validated successfully.
serialNumber and sapNumber are strings and may be empty; leading zeroes in serial numbers are significant.
The response included carId as a number or null.
dongleTerminationTimeStamp was null throughout the validated set and is a legacy artifact without current functionality.

Async behavior

Synchronous.

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

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

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Products were retrieved successfully

application/json

Array<object>

object

Product database ID

number

uniqueId

Unique product identifier

string

serialNumber

Product serial number

string

sapNumber

SAP number

string

dongleTerminationTimeStamp

Functionally obsolete legacy field; do not use for integration logic

string | null

type

Product type, for example flinkey Box

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 or customer context was not found

Recommended handling: Check credentials, token context and Customer-ID

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent