Get user

GET

/users/{userId}

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

Purpose

Retrieve one specific user by user ID in the selected customer context.

A user represents the access identity that can receive assignments for cars.

For standard full partner integrations, the partner backend usually works with anonymous flinkey users.

Use this operation to validate or inspect an existing user mapping.

When to use this operation

Use this operation when the partner backend needs to retrieve one specific flinkey user.

Typical situations:

validating a local user mapping,
checking whether a mapped user still exists,
troubleshooting assignment creation,
reconciling partner customer or driver records with flinkey user records,
inspecting user data before using the user in an assignment flow.

In most integrations, the partner backend should persist a mapping between the partner customer or driver and the flinkey userId.

Use the mapped userId to retrieve the correct flinkey user.

Do not create a new user when an existing mapped user should be used.

Validation notes

PROD validation result:

GET /users/{userId} was successfully executed with flinkey-API-Key, Authorization: Bearer {{accessToken}} and Customer-ID.
The response is a single user object.
id is returned as number.
emailAddress is returned as string.
userData is returned as an object containing firstName and lastName.
Concrete names and e-mail addresses from validation must not be copied into public documentation, examples, screenshots or AI prompts.
OData collection query options such as $filter, $orderby, $count, $skip and $top are not supported because this endpoint returns a single resource, not a collection.
$select was tested and resulted in a timeout. The flinkey API does not support $select; do not use it on this or any other endpoint.
Use GET /users for OData-based filtering, ordering, paging or collection query behavior.

Async behavior

Synchronous.

The user is 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.

User identifiers are environment-specific.

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

userId

required

number

Database ID of the user

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

User was retrieved successfully

application/json

object

User database ID

number

emailAddress

E-mail address of the user

string

userData

User profile data

object

userData.firstName

First name

string | null

userData.lastName

Last name

string | null

Example

{
  "id": 123,
  "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 user was not found

Recommended handling: Check credentials, Customer-ID and local userId mapping

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent