Get brands

GET

/brands

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

Purpose

Retrieve available vehicle brands for keyfob matching.

The keyfob area helps determine which key fits to a car.

Use this operation as the first lookup step when a partner or operational backend needs to identify available keyfob data by vehicle brand.

The response is a list of brand names.

When to use this operation

Use this operation when the partner backend or operational backend needs to retrieve available brands before looking up matching keys.

Typical situations:

preparing a keyfob selection workflow,
supporting operational keybed or keyfob matching,
allowing a user or support agent to select a vehicle brand,
validating whether a vehicle brand is available in the keyfob data,
preparing a follow-up call to retrieve keys of a specific brand.

For standard access flows, partner backends usually work primarily with Car, User and Assignment.

Use keyfob operations for key matching, setup and support workflows.

Validation notes

The request succeeded with 200 OK without a Customer-ID header.
The response was a direct array of uppercase brand-name strings.
$top, $skip, $orderby=$it desc and $filter=$it eq 'BMW' were validated successfully.
Brand names can contain spaces and must be URL-encoded when used as the brand path parameter.
Case-insensitive matching was not validated and must not be assumed.

Async behavior

Synchronous.

The brand list 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.

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

string

Not required for this operation

Responses

200

Brands were retrieved successfully

application/json

Array<object>

object

item

Vehicle brand name

string

Example

[
  "Volkswagen"
]

401

Invalid subscription key or missing / invalid access token

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

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent