Skip to content

Customers

Info

Customer or entity, represented by a customer ID, which is considered to have several API Managers, managers, users, cars, flinkey Boxes.

Get customers

GET /customers

Tip

The returned data can be manipulated using OData.

Request parameters

Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
`Customer-ID string header Required. The database ID of the customer.

Response

200 OK

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      }
    }
  }
}

Response

401 UNAUTHORIZED

Access denied due to invalid subscription key. 
Make sure to provide a valid key for an active subscription.
{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
{
  "statusCode": 401,
  "message": "Unauthorized. Access token is missing or invalid."
} 

Response

404 NOT FOUND

Unable to find a manager for the given OAuth ID claim data.

Response

500 INTERNAL SERVER ERROR

Internal server error.

Info

The customerId must be sent in each request to the other endpoints (header value Customer-ID). The customerId will be found in the flinkey Portal under section developers -> API.