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.
Neu bei der API? Lesen Sie den Erste Schritte-Leitfaden, um die Authentifizierung einzurichten und Ihre erste Anfrage in wenigen Minuten zu senden.
Schnellzugriff
Authentifizierung, OData-Grundlagen und Ihre erste Anfrage
💻 Code-BeispieleFunktionierende C#-Beispiele mit Simple.OData.Client
📂 ProjekteProjekte erstellen, lesen, aktualisieren und verwalten
✅ AufgabenProjektaufgaben und private Aufgaben bearbeiten
⏱️ ZeiterfassungZeiterfassungsdaten erfassen und abfragen
💰 Budget & PositionenBudgets, Positionen, Rechnungsstellung und Vorlagen
📄 DokumenteDateien, Ordner und Hyperlinks verwalten
📅 PlanungGantt-Diagramm-Planungselemente und Veröffentlichungen
Basis-URLs
Verwenden Sie die passende Basis-URL je nach Ihrer InLoox-Bereitstellung:
InLoox Cloud:
https://app.inloox.com/api/odata/
InLoox Self-Hosted:
https://YOUR-SELF-HOSTED-URL/api/v1/odata/
Alle Endpunkt-Pfade in dieser Dokumentation sind relativ zur oben genannten Basis-URL. Zum Beispiel bedeutet Project für Cloud-Nutzer https://app.inloox.com/api/odata/Project.
Authentifizierung
Die InLoox API verwendet Personal Access Tokens zur Authentifizierung. Fügen Sie Ihren Token bei jeder Anfrage über den HTTP-Header x-api-key hinzu:
GET /api/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, ProjectStatus, 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. |
| Checklisten | CheckList, CheckListColumn, CheckListDataRow, CheckListTemplate | Strukturierte Checklisten mit Spalten, Zeilen und wiederverwendbaren Vorlagen. |
| Kontakte & Benutzer | Client, UserInfo, DynamicContact, Division, Skill | Kontakte, Benutzerprofile, Abteilungen und Fähigkeiten verwalten. |
| Benutzerdefinierte Felder | CustomField, CustomFieldDefinition, CustomFieldPermission | Benutzerdefinierte Felder über Entitäten hinweg definieren und verwalten. |
| Portfolios | Portfolio, PortfolioTarget | Portfoliomanagement und Zielverfolgung. |
| Kategorien & Stammdaten | Category, Client, ProjectStatus, TaskStatus | Kategorien, Kunden, Statusdefinitionen und Vorlagen. |
| Kalender & Arbeitszeit | Calendar, WorkingTime, WorkingTimeDayOff, ContactNonWorkingTime | Arbeitszeitkalender, Freitage-Definitionen und arbeitsfreie Zeiten. |
| Konfiguration & Berechtigungen | Configuration, NotificationFilterSetting, RolePermission, UserPermission | Systemeinstellungen, Benachrichtigungspräferenzen, Rollen und Berechtigungen. |
| Aktivitätsfeed | Activity (verschiedene Funktionen) | Aktivitätsfeeds für Projekte, Aufgaben, Dokumente und Zeiteinträge abrufen. |