Zum Hauptinhalt springen

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

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


Schnellzugriff


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/
info

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.

GruppeWichtige EndpunkteBeschreibung
ProjekteProject, ProjectNote, ProjectStatus, DynamicProjectProjekte erstellen, lesen, aktualisieren und löschen. Mitglieder, Kategorien, Gruppen und Favoriten verwalten.
AufgabenTask, TaskItemNote, TaskStatus, DynamicTaskItemProjektaufgaben und private Aufgaben verwalten. Mitwirkende zuweisen, Status verfolgen und Stoppuhr nutzen.
ZeiteinträgeTimeEntry, TimeEntryComment, DynamicTimeEntryZeiterfassungsdaten erfassen und abfragen. Einträge kopieren und Notizen hinzufügen.
Budget & PositionenBudget, LineItem, BudgetGroup, BudgetPresetFinanzverfolgung — Budgets, Positionen, Rechnungsstellung und Vorlagen.
DokumenteDocument, DocumentFolder, DocumentFolderStructureDateiverwaltung — Hochladen, Verknüpfen, Ordnerstruktur organisieren, Favoriten verfolgen.
PlanungPlanning, PlanningPublication, PlanningTemplateGantt-Diagramm-Elemente — Terminplanung, Abhängigkeiten, Snapshots und Rückwärtsplanung.
Mind MapsMindMap, MindMapNode, MindMapTemplateMind Maps mit Knoten erstellen und verwalten. Knoten in Aufgaben oder Zeitachse kopieren.
ChecklistenCheckList, CheckListColumn, CheckListDataRow, CheckListTemplateStrukturierte Checklisten mit Spalten, Zeilen und wiederverwendbaren Vorlagen.
Kontakte & BenutzerClient, UserInfo, DynamicContact, Division, SkillKontakte, Benutzerprofile, Abteilungen und Fähigkeiten verwalten.
Benutzerdefinierte FelderCustomField, CustomFieldDefinition, CustomFieldPermissionBenutzerdefinierte Felder über Entitäten hinweg definieren und verwalten.
PortfoliosPortfolio, PortfolioTargetPortfoliomanagement und Zielverfolgung.
Kategorien & StammdatenCategory, Client, ProjectStatus, TaskStatusKategorien, Kunden, Statusdefinitionen und Vorlagen.
Kalender & ArbeitszeitCalendar, WorkingTime, WorkingTimeDayOff, ContactNonWorkingTimeArbeitszeitkalender, Freitage-Definitionen und arbeitsfreie Zeiten.
Konfiguration & BerechtigungenConfiguration, NotificationFilterSetting, RolePermission, UserPermissionSystemeinstellungen, Benachrichtigungspräferenzen, Rollen und Berechtigungen.
AktivitätsfeedActivity (verschiedene Funktionen)Aktivitätsfeeds für Projekte, Aufgaben, Dokumente und Zeiteinträge abrufen.