---
title: "API and Interface from LUX (only in luxenterprise)"
manual: "LUX"
version: "44.4"
permalink: "https://docs.typo3.org/permalink/in2code/lux:api-and-interface-from-lux-only-in-luxenterprise@44.4"
source: "Technical/API/Index.md"
rendered: "2026-10-01T13:13:23+00:00"
---

![LUX](../../Images/logo_claim.svg#gh-light-mode-only) ![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only)

# API and Interface from LUX (only in luxenterprise) {#api-and-interface-from-lux-only-in-luxenterprise}

Since LUXenterprise 19.0.0 we introduced a proper interface with reading access as you may know from other REST APIs.

## Configuration {#configuration}

First of all you have to check the extension manager configuration of LUXenterprise, to turn on the API and to add an Api-Key and to define which IP-addresses are allowed to read from the API (optional)

| Title | Default value | Description |
| --- | --- | --- |
| api | 0 | Enable or disable the API of LUX |
| apiKey | - | You have to enter a random value that will be used then as API-KEY for authentication. Note: Minimum 128 characters are needed! |
| apiKeyIpAllowList | - | Define one or more IPs or ranges (optional) for allowing to read the API (e.g. 192.0.0.1,192.168.0.0/24,fc00::,2001:db8::567:89ab) |

**Note:** Take care to add the typenum `1650897821` to your siteconfiguration (see FAQ for more details). In our example `luxenterprise_api.json` will be recognized from TYPO3 routing (see CURL examples below).

## Endpoints {#endpoints}

The API works as most interfaces by selecting an endpoint and passing arguments as JSON. The result is also always a JSON output.

Available endpoints are:

### [FindByProperty to get a single lead](https://docs.typo3.org/permalink/in2code/lux:endpoint-findbyproperty-for-getting-a-single-visitor-reading-access@44.4) {#findbyproperty-to-get-a-single-lead}

### [FindAllByAnyProperties to get a list of leads](https://docs.typo3.org/permalink/in2code/lux:endpoint-findallbyanyproperties-for-getting-a-list-of-visitors-reading-access@44.4) {#findallbyanyproperties-to-get-a-list-of-leads}