InLoox API-Referenz

Die InLoox API ist eine OData v4–kompatible REST API, die Ihnen programmatischen Zugriff auf Ihre InLoox-Daten ermöglicht — Projekte, Aufgaben, Zeiteinträge, Budgets, Dokumente und mehr. Nutzen Sie sie, um individuelle Integrationen zu erstellen, Workflows zu automatisieren oder InLoox mit anderen Systemen zu synchronisieren.

Schnellstart

Lesen Sie den Erste Schritte-Leitfaden, um die Authentifizierung einzurichten und Ihre erste Anfrage in wenigen Minuten zu senden.

Vorsicht bei Schreiboperationen

Die meisten Datenoperationen (Erstellen, Aktualisieren, Löschen) können nicht rückgängig gemacht werden. Daten können dabei unwiderbringlich verloren gehen.

Löschungen haben aufgrund der Datenstruktur mögliche Seiteneffekte, z. B. werden beim Entfernen von Eltern-Entitäten auch deren Kind-Entitäten mit entfernt, um Löschanomalien zu verhindern.

Testen und Entwickeln Sie deshalb immer zuerst auf einem nicht-produktiven Sandbox-Account und sichern Sie Produktivdaten, bevor Sie schreibende API-Operationen in der Produktivumgebung ausführen.

---

Schnellzugriff

Erste Schritte

Authentifizierung, OData-Grundlagen und Ihre erste Anfrage

Code-Beispiele

Funktionierende C#-Beispiele mit Simple.OData.Client

Projekte

Projekte erstellen, lesen, aktualisieren und verwalten

Aufgaben

Projektaufgaben und private Aufgaben bearbeiten

Zeiterfassung

Zeiterfassungsdaten erfassen und abfragen

Budget & Positionen

Budgets, Positionen, Rechnungsstellung und Vorlagen

Dokumente

Dateien, Ordner und Hyperlinks verwalten

Planung

Gantt-Diagramm-Planungselemente und Veröffentlichungen

Dokumentations-MCP

KI-Tools über MCP mit der InLoox-Dokumentation verbinden

---

Basis-URLs

Verwenden Sie die passende Basis-URL je nach Ihrer InLoox-Bereitstellung:

InLoox Cloud:

https://app.inloox.com/api/

InLoox Self-Hosted:

https://YOUR-SELF-HOSTED-URL/api/v1/

info

Alle Endpunkt-Pfade in dieser Dokumentation sind relativ zur oben genannten Basis-URL. Zum Beispiel bedeutet odata/Project für Cloud-Nutzer https://app.inloox.com/api/odata/Project, für InLoox Self-Hosted mit der Server-Url https://inloox.meinefirma.org beispielsweise https://inloox.meinefirma.org/api/v1/odata/Project.

---

Authentifizierung

Die InLoox API verwendet Personal Access Tokens zur Authentifizierung. Fügen Sie Ihr Token bei jeder Anfrage über den HTTP-Header x-api-key hinzu:

GET /odata/Project HTTP/1.1
Host: app.inloox.com
x-api-key: YOUR_API_TOKEN

Ausführliche Informationen zur Erstellung und Verwendung von Tokens finden Sie im Erste Schritte-Leitfaden.

---

Verfügbare Entitäten

Die API stellt die folgenden Entitätsgruppen bereit. Klicken Sie auf einen Gruppennamen für die detaillierte Dokumentation.

Gruppe	Wichtige Endpunkte	Beschreibung
Projekte	Project, ProjectNote, DynamicProject	Projekte erstellen, lesen, aktualisieren und löschen. Mitglieder, Kategorien, Gruppen und Favoriten verwalten.
Aufgaben	Task, TaskItemNote, TaskStatus, DynamicTaskItem	Projektaufgaben und private Aufgaben verwalten. Mitwirkende zuweisen, Status verfolgen und Stoppuhr nutzen.
Zeiteinträge	TimeEntry, TimeEntryComment, DynamicTimeEntry	Zeiterfassungsdaten erfassen und abfragen. Einträge kopieren und Notizen hinzufügen.
Budget & Positionen	Budget, LineItem, BudgetGroup, BudgetPreset	Finanzverfolgung — Budgets, Positionen, Rechnungsstellung und Vorlagen.
Dokumente	Document, DocumentFolder, DocumentFolderStructure	Dateiverwaltung — Hochladen, Verknüpfen, Ordnerstruktur organisieren, Favoriten verfolgen.
Planung	Planning, PlanningPublication, PlanningTemplate	Gantt-Diagramm-Elemente — Terminplanung, Abhängigkeiten, Snapshots und Rückwärtsplanung.
Mind Maps	MindMap, MindMapNode, MindMapTemplate	Mind Maps mit Knoten erstellen und verwalten. Knoten in Aufgaben oder Zeitachse kopieren.
Listen	CheckList, CheckListColumn, CheckListDataRow, CheckListTemplate	Strukturierte Listen mit Spalten, Zeilen und wiederverwendbaren Vorlagen.
Portfolios	Portfolio, PortfolioTarget	Portfoliomanagement und Zielverfolgung.
Kontakte & Benutzer	UserInfo, DynamicContact	Kontakte, Benutzerprofile, Abteilungen und Fähigkeiten verwalten.
Kalender & Arbeitszeiten	Calendar, WorkingTime, WorkingTimeDayOff, ContactNonWorkingTime	Arbeitszeitkalender, Definitionen für freie Tage und arbeitsfreie Zeiten.
Benutzerdefinierte Felder	CustomField, CustomFieldDefinition, CustomFieldPermission	Benutzerdefinierte Felder über Entitäten hinweg definieren und verwalten.
Organisation & Stammdaten	Category, Client, Division, ProjectStatus, Skill	Kategorien, Kunden, Statusdefinitionen und Vorlagen.
Berechtigungen & Sicherheitskonfiguration	RolePermission, UserPermission, ValidInviteDomain, ValidLoginDomain	Rollen- und Nutzerberechtigungen sowie Domänen-Einstellungen.