Skip to content
flinkeyflinkey for Developers

Overview

flinkey API v3 0.20

Section titled “flinkey API v3 0.20”

Interactive API reference for the flinkey API v3.

Document version: 0.20
Last updated: 2026-07-23

Important: Every integration starts on the UAT environment. Access to the production environment is granted only after successful validation by the flinkey team.

For questions or support, contact developers@flinkey.com.

Download OpenAPI specification

Information

  • OpenAPI version: 3.1.2

Operations

Section titled “Operations”
POST
/sdk/token
PUT
/assignments
GET
/assignments/{assignmentId}
DELETE
/assignments/{assignmentId}
PATCH
/assignments/{assignmentId}
GET
/cars/{carId}/assignments
GET
/users/{userId}/assignments
POST
/oauth2/token
GET
/cars
PUT
/cars
GET
/cars/{carId}
DELETE
/cars/{carId}
PATCH
/cars/{carId}
GET
/cars/{carId}/products
GET
/services/{serviceId}/contracts
GET
/customers
PUT
/events
GET
/events/{eventId}
GET
/cars/{carId}/events
GET
/groups/{groupId}/cars
PUT
/groups/{groupId}/cars
GET
/groups/{groupId}/products
PUT
/groups/{groupId}/products
GET
/groups/{groupId}/services
PUT
/groups/{groupId}/services
GET
/groups/{groupId}/users
PUT
/groups/{groupId}/users
GET
/groups
PUT
/groups
DELETE
/groups/{groupId}
PATCH
/groups/{groupId}
DELETE
/groups/{groupId}/cars/{carId}
DELETE
/groups/{groupId}/products/{productId}
DELETE
/groups/{groupId}/services/{serviceId}
DELETE
/groups/{groupId}/users/{userId}
PUT
/installations
DELETE
/installations
GET
/brands
GET
/brands/{brand}/keys
GET
/products/{productId}/cars
GET
/products/{productId}
GET
/products
GET
/products/{productId}/services
GET
/services/{serviceId}/products
GET
/services/{serviceId}
GET
/services
PUT
/users/assignments/customers
DELETE
/users/assignments/customers
GET
/users
PUT
/users
GET
/users/{userId}
POST
/webhooks/assignmentCreatedResult
POST
/webhooks/assignmentDeletedResult
POST
/webhooks/assignmentUpdatedResult

Authentication

Section titled “Authentication”

apiKey

Section titled “apiKey”

Partner-specific API key from the flinkey Portal.

Security scheme type: apiKey

Header parameter name: flinkey-API-Key

bearerAuth

Section titled “bearerAuth”

Access token returned by POST /oauth2/token.

Security scheme type: http

Bearer format: access token