Get service

GET

/services/{serviceId}

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

Purpose

Retrieve one specific service by service ID 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 one specific service.

Typical situations:

validating a service reference,
checking the assigned product ID,
checking whether a service is terminated,
retrieving service termination date,
retrieving service termination cause,
supporting operational troubleshooting,
reconciling service information with partner or support records.

Do not treat Service as the primary access permission object.

Access permissions are managed through assignments between User and Car.

Validation notes

Active and terminated service objects were retrieved successfully with 200 OK.
name can be a string or null.
An active service returned a numeric productId, isTerminated: false and null termination fields.
A terminated service returned productId: null, isTerminated: true, a populated terminationDate and terminationCause: ServiceIsNotNeededAnymore.
Collection-style OData options returned 400 Bad Request because the resource is not a collection.

Async behavior

Synchronous.

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

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

Path Parameters

serviceId

required

number

Database ID of the service

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Service was retrieved successfully

application/json

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, customer context or service was not found

Recommended handling: Check credentials, Customer-ID and local serviceId reference

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent