Get cars of group

GET

/groups/{groupId}/cars

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

Purpose

Retrieve cars 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 cars must be retrieved.

When to use this operation

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

Typical situations:

listing cars of a group,
validating group membership for cars,
supporting grouping-based administration workflows,
reconciling grouped car records with partner or support records,
preparing operational workflows for a subset of cars,
checking whether a car 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.

Async behavior

Synchronous.

The cars 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 car identifiers are environment-specific.

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

Cars of the group were retrieved successfully

application/json

Array<object>

object

Car database ID

number

name

Car name

string

description

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