Get assignment

GET

/assignments/{assignmentId}

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

Purpose

Retrieve one specific assignment by assignment ID in the selected customer context.

An assignment grants access from a user to a car for a defined time range.

Use this operation to validate or inspect an existing assignment.

The returned assignment data can be used for reconciliation, support workflows or backend state validation.

When to use this operation

Use this operation when the partner backend needs to retrieve one specific flinkey assignment.

Typical situations:

validating a local assignment mapping,
checking whether a mapped assignment still exists,
troubleshooting mobile access,
troubleshooting webhook processing,
reconciling partner access records with flinkey assignment records,
inspecting assignment start and end times,
validating assignment lifetime and renewal data.

In most integrations, the partner backend should persist a mapping between the partner access context and the flinkey assignmentId.

Use the mapped assignmentId to retrieve the correct flinkey assignment.

Do not create a new assignment when an existing mapped assignment should be used or updated.

Validation notes

PROD validation result:

GET /assignments/{assignmentId} was successfully executed with flinkey-API-Key, Authorization: Bearer {{accessToken}} and Customer-ID.
The response is a single assignment object.
id, carId and userId are returned as numbers.
start is returned as UTC timestamp string.
end may be null.
lifetime is returned as number when provided.
renewableAfter may be null.
OData collection query options such as $filter, $orderby, $count, $skip and $top are not supported because this endpoint returns a single resource, not a collection.
$select was tested and resulted in a timeout; do not use $select for this endpoint.
Use assignment collection endpoints for OData-based filtering, ordering, paging or collection query behavior.

Async behavior

Synchronous.

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

Assignment identifiers are environment-specific.

Do not mix UAT and PROD assignment 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

assignmentId

required

number

Database ID of the assignment

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Assignment was retrieved successfully

application/json

object

Assignment database ID

number

carId

Car database ID assigned to the user

number

userId

User database ID assigned to the car

number

start

Assignment start time as UTC timestamp

string

end

Assignment end time as UTC timestamp, or null for open-ended access

string | null

lifetime

Assignment lifetime in seconds

number | null

renewableAfter

Renewal timing information, if provided

number | null

Example

{
  "id": 10001,
  "carId": 20001,
  "userId": 30001,
  "start": "2026-02-10T10:11:02.240Z",
  "end": null,
  "lifetime": 604800,
  "renewableAfter": 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 assignment was not found

Recommended handling: Check credentials, Customer-ID and local assignmentId mapping

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent