Get users of group

GET

/groups/{groupId}/users

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

Purpose

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

When to use this operation

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

Typical situations:

listing users of a group,
validating group membership for users,
supporting grouping-based administration workflows,
reconciling grouped user records with partner or support records,
preparing operational workflows for a subset of users,
checking whether a user 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 user.
Assignment and subsequent removal were confirmed through control GET requests.
$filter, $orderby, $top and $skip were accepted as documented above.
All personal data in this document remains represented by placeholders.

Async behavior

Synchronous.

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

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

Users of the group were retrieved successfully

application/json

Array<object>

object

User database ID

number

emailAddress

User email address

string

userData

User data object

object

userData.firstName

User first name

string | null

userData.lastName

User last name

string | null

Example

[
  {
    "id": 54321,
    "emailAddress": "user@example.com",
    "userData": {
      "firstName": "Max",
      "lastName": "Mustermann"
    }
  }
]

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