Get groups

GET

/groups

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

Purpose

Retrieve groups available 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 grouping, lookup, reconciliation and support workflows where grouped entities must be retrieved.

When to use this operation

Use this operation when the partner backend or operational backend needs to retrieve available groups for a customer.

Typical situations:

listing groups for operational tooling,
checking whether a group exists,
preparing follow-up calls for cars, users, services or products of a group,
supporting grouping-based administration workflows,
reconciling group records with partner or support records,
validating group setup before assigning entities to a 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

The initial request returned 200 OK with an empty array.
After controlled group creation, the same operation returned the created group as an object containing numeric id and string name.
No OData query options were used or validated.

Async behavior

Synchronous.

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

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

Groups were retrieved successfully

application/json

Array<object>

object

Group database ID

integer

name

Group name

string

Example

[
  {
    "id": 200,
    "name": "Fleet Berlin"
  }
]

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