Get customers

GET

/customers

const url = 'https://api-uat.flinkey.de/v3/customers';
const options = {
  method: 'GET',
  headers: {'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/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'flinkey-API-Key: <flinkey-API-Key>'

Purpose

Retrieve all customer contexts that the authenticated API Manager is authorized to access.

This is the first protected endpoint used after token retrieval. It verifies the effective API Manager scope and returns the customer IDs that can be used for subsequent customer-scoped requests.

The request does not require a Customer-ID header. The response is an array because an API Manager can reach one or more customer contexts.

When to use this operation

Use this operation when the partner backend needs to discover or validate the customer contexts available to the authenticated API Manager.

Typical situations:

initial integration setup,
backend configuration validation,
checking which customer contexts the API Manager can reach,
verifying UAT or PROD configuration,
retrieving the IDs and names available for subsequent customer-scoped requests,
troubleshooting authorization or customer-context issues.

In most integrations, the intended Customer-ID should be selected from this response and then configured for subsequent customer-scoped requests.

Validation notes

PROD validation result:

GET /customers was successfully executed with flinkey-API-Key and Authorization: Bearer {{accessToken}}, without a Customer-ID header.
The endpoint returned all customer contexts reachable by the authenticated API Manager.
The response is an array.
id is returned as number.
name is returned as string.
$top is supported.
$skip is supported.
$filter is supported.
$orderby is supported.
$select is not supported; using $select returns no result.

Async behavior

Synchronous.

The customer context 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.

For standard partner integrations, the mobile app must not receive API Manager credentials, backend bearer tokens or the flinkey-API-Key.

Use placeholders in documentation, examples, screenshots and AI prompts.

Authorizations

apiKey
bearerAuth

Parameters

Header Parameters

Customer-ID

string

Not required; omitting it allows the endpoint to list all customer contexts reachable by the API Manager

Responses

200

Reachable customer contexts were retrieved successfully

application/json

Array<object>

object

Customer database ID

number

name

Customer name

string

Example

[
  {
    "id": 123,
    "name": "Example Fleet GmbH"
  }
]

400

Request is invalid

Recommended handling: Check headers and request format

401

Invalid subscription key or missing / invalid access token

Recommended handling: Check flinkey-API-Key, bearer token and environment configuration

404

API Manager context could not be resolved

Recommended handling: Check API Manager credentials and environment

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent