Get products of group

GET

/groups/{groupId}/products

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

Purpose

Retrieve products assigned to one specific group in the selected customer context.

A group is an entity represented by a group ID.

A group can contain cars, users, services and products.

Use this operation for operational lookup, reconciliation and support workflows where grouped products must be retrieved.

When to use this operation

Use this operation when the partner backend or operational backend needs to retrieve products assigned to a specific group.

Typical situations:

listing products of a group,
validating group membership for products,
supporting grouping-based administration workflows,
reconciling grouped product records with partner or support records,
preparing operational workflows for a subset of products,
checking whether a product is assigned to the intended group.

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

Use grouping operations where the integration or operational process explicitly works with grouped cars, users, services or products.

Validation notes

PROD returned 200 OK with a direct JSON array and no OData wrapper.
The collection was observed both empty and with one assigned product.
Assignment and subsequent removal were confirmed through control GET requests.
$filter, $orderby, $top and $skip were accepted as documented above.

Async behavior

Synchronous.

The products assigned to the group 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.

Group and product identifiers are environment-specific.

Do not mix UAT and PROD group IDs or 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

groupId

required

integer

Database ID of the group

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Products of the group 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 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

Car currently linked to the product; returned by PROD although omitted from the public response schema

number | null

Example

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

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 group was not found

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

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent