Get services

GET

/services

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

Purpose

Retrieve services available in the selected customer context.

A service represents the contract or service relationship associated with a flinkey product.

Use this operation for operational lookup, reconciliation and support workflows where service-level information is required.

In standard developer integrations, partner backends usually work primarily with Car, User and Assignment.

When to use this operation

Use this operation when the partner backend needs to retrieve or search services assigned to the selected customer context.

Typical situations:

operational support,
contract or service reconciliation,
checking which services are available for a customer,
checking whether services are terminated,
retrieving service termination dates,
retrieving service termination causes,
relating services to products,
troubleshooting vehicle or box setup.

Do not treat Service as the primary access permission object.

Access permissions are managed through assignments between User and Car.

Validation notes

The base request returned 200 OK with a direct JSON array.
$top, $skip, $orderby=id desc and $filter=isTerminated eq true were validated successfully.
name can be a string or null.
Validated active services returned isTerminated: false with null termination fields.
Validated terminated services returned isTerminated: true, populated termination fields and productId: null.
terminationDate was returned without a timezone designator and with variable fractional-second precision. Do not interpret it as UTC without additional context.
ServiceIsNotNeededAnymore was the observed termination cause.

Async behavior

Synchronous.

The services 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.

Service and product identifiers are environment-specific.

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

Services were retrieved successfully

application/json

Array<object>

object

Service database ID

number

name

Service name, if available

string | null

productId

Product database ID assigned to the service

number | null

isTerminated

Indicates whether the service is terminated

boolean

terminationDate

Service termination date in date-time format, if available

string | null

terminationCause

Termination cause, if available

string | null

Example

[
  {
    "id": 11111,
    "name": "flinkey Access",
    "productId": 67890,
    "isTerminated": false,
    "terminationDate": null,
    "terminationCause": null
  }
]

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