Kontakte & Benutzer

In InLoox werden Benutzer-Informationen und Kontakte über verschiedene Endpunkte verwaltet. Diese Seite beschreibt alle relevanten Entitäten und deren API-Zugriffsmöglichkeiten.

info

Für den Zugriff auf benutzerdefinierte Felder eines Kontakts verwenden Sie den DynamicContact-Endpunkt. Dieser liefert neben den Standardeigenschaften auch alle konfigurierten benutzerdefinierten Felder zurück.

---

UserInfo

Die UserInfo-Entität repräsentiert den aktuell authentifizierten Benutzer oder andere Benutzer im System. Über diese Endpunkte können Sie Profilinformationen abrufen, Benachrichtigungsfrequenzen festlegen und Zeitzonen konfigurieren.

Datenmodell

Eigenschaft	Typ	Beschreibung
ContactId	guid	Eindeutige ID des Kontakts.
FirstName	string	Vorname des Benutzers.
LastName	string	Nachname des Benutzers.
DisplayName	string	Anzeigename des Benutzers.
Email	string	E-Mail-Adresse des Benutzers.
ImageId	string	ID des Profilbilds.
NotifyFrequency	int	Benachrichtigungsfrequenz in Minuten. Werte: -1 (deaktiviert), 0 (sofort), 60 (stündlich), 1440 (täglich), 10080 (wöchentlich).
TimeZoneInfo	string	Zeitzoneninformation des Benutzers.
EmailConfirmed	bool	Gibt an, ob die E-Mail-Adresse bestätigt wurde.
IsReader	bool	Gibt an, ob der Benutzer eine Nur-Lesen-Lizenz besitzt.
UILanguage	string	Sprache der Benutzeroberfläche.

Endpunkte

Alle Benutzerinformationen abrufen, auf die Sie Zugriff haben

GET/odata/UserInfo

Unterstützt OData-Abfrageoptionen.

---

Informationen des aktuellen Benutzers abrufen

GET/odata/UserInfo/Me()

Gibt die Profilinformationen des aktuell authentifizierten Benutzers zurück.

---

Benachrichtigungsfrequenz festlegen

GET/odata/UserInfo/SetNotificationFrequency(frequency={frequency})

Parameter	Typ	Erforderlich	Beschreibung
frequency	int	✅	Die gewünschte Benachrichtigungsfrequenz als ganzzahliger Wert.

Gültige Werte:

Wert	Name	Bedeutung
-1	Deaktiviert	Benachrichtigungen aus
0	Sofort	Sofortige Zustellung
60	Stündlich	Alle 60 Minuten
1440	Täglich	Alle 1440 Minuten (24 h)
10080	Wöchentlich	Alle 10080 Minuten (7 Tage)

---

Telemetriestatus des aktuellen Benutzers prüfen

GET/odata/UserInfo/TelemetryEnabledForCurrentUser()

Gibt zurück, ob Telemetriedaten für den aktuellen Benutzer aktiviert sind.

---

Passende Zeitzoneninformation ermitteln

GET/odata/UserInfo/MatchTimeZoneInfo()

Ermittelt automatisch die passende Zeitzone basierend auf den aktuellen Einstellungen.

---

Zeitzoneninformation festlegen

POST/odata/UserInfo({key})/SetTimeZoneInfo

Legt die Zeitzone für den angegebenen Benutzer fest. Gibt die aktualisierte ApiUserInfo-Entität zurück.

Parameter	Typ	Erforderlich	Beschreibung
key	guid	✅	Die ContactId des Benutzers.
Body	object	✅	JSON-Objekt mit folgendem Feld: timeZoneInfo (string, erforderlich) — Eine IANA-Zeitzonen-ID (z. B. "Europe/Berlin", "America/New_York").

---

DynamicContact

Der DynamicContact-Endpunkt stellt eine erweiterte Ansicht auf Kontakte bereit, die neben den Standardeigenschaften auch benutzerdefinierte Felder, Fertigkeiten und Abteilungszugehörigkeiten enthält.

Datenmodell

Eigenschaft	Typ	Beschreibung
ContactId	guid	Eindeutige ID des Kontakts.
Name	string	Vollständiger Name.
EntryId	string	Externe Eintrags-ID (z. B. aus Exchange).
Address	string	Vollständige Adresse.
Sid	string	Security Identifier.
Type	string	Kontakttyp. Veraltet, enthält immer "INLOOX"
Title	string	Anrede oder akademischer Titel.
FirstName	string	Vorname.
LastName	string	Nachname.
CompanyName	string	Firmenname.
Street	string	Straße.
Zip	string	Postleitzahl.
Location	string	Ort.
Country	string	Land.
DisplayName	string	Anzeigename.
Supervisor	string	Vorgesetzter.
Position	string	Stellenbezeichnung.
Website	string	Webseite.
Initials	string	Initialen.
Department	string	Abteilung.
Assistenz	string	Assistenz.
Phone	string	Telefonnummer (primär).
Phone2	string	Telefonnummer (sekundär).
Fax	string	Faxnummer.
Mobile	string	Mobilnummer.
Pager	string	Pagernummer.
Email	string	E-Mail-Adresse.
Birthday	DateTimeOffset?	Geburtsdatum.
AddressBookId	guid?	ID des zugeordneten Adressbuchs.
CreatedByContactId	guid?	ID des erstellenden Kontakts.
ChangedByContactId	guid?	ID des zuletzt ändernden Kontakts.
CreatedDate	DateTimeOffset?	Erstellungsdatum.
ChangedDate	DateTimeOffset?	Änderungsdatum.
OriginalSid	string	Ursprünglicher Security Identifier.
DescriptionId	guid?	ID der verknüpften Beschreibung.
NotifyFrequency	int?	Benachrichtigungsfrequenz in Minuten. Werte: null (nicht gesetzt), -1 (deaktiviert), 0 (sofort), 60 (stündlich), 1440 (täglich), 10080 (wöchentlich).
State	string	Bundesland/Region.
UILanguage	string	Sprache der Benutzeroberfläche.
IsRecycled	bool	Ob der Kontakt gelöscht (recycelt) wurde.
Skills	string	Kommagetrennte Liste der Fertigkeiten.
Divisions	string	Kommagetrennte Liste der Abteilungen.
IsIdentity	bool	Ob ein Anmeldekonto existiert.
DescriptionText	string	Beschreibung als Klartext.
DescriptionHTML	string	Beschreibung als HTML.
AzureAdObjectId	string	Azure AD Objekt-ID.
LicenseType	int	Lizenztyp des Benutzers. Werte: 0 (Reader — Nur-Lesen), 2 (Full — Vollzugriff), 3 (Blocked — Gesperrt).
TimeZoneInfo	string	Zeitzoneninformation. Eine IANA-Zeitzonen-ID (z. B. "Europe/Berlin", "America/New_York")
EmailConfirmed	bool	Ob die E-Mail-Adresse bestätigt ist.
InvitationAccepted	bool	Ob die Einladung angenommen wurde.
CalendarId	guid	ID des zugewiesenen Kalenders.
Capacity	int	Kapazität des Kontakts (in Prozent).
ProjectRequestCreate	bool	Berechtigung zum Erstellen von Projektanfragen.
ProjectRequestRelease	bool	Berechtigung zum Freigeben von Projektanfragen.
CustomProperties	object	Benutzerdefinierte Felder als dynamisches Objekt.

Endpunkte

Alle Kontakte mit benutzerdefinierten Feldern abrufen

GET/odata/DynamicContact

Gibt eine vollständige Liste aller Kontakte einschließlich benutzerdefinierter Felder zurück. Unterstützt alle Standard-OData-Abfrageoptionen.

---

OData-Abfragebeispiele

Aktuellen Benutzer abrufen

Ruft das Profil des authentifizierten Benutzers über die Me()-Funktion ab:

GET /odata/UserInfo/Me()

Kontakte mit Filter abrufen

DynamicContact mit $select und $filter abfragen, um spezifische Felder für Kontakte abzurufen, die einer Bedingung entsprechen:

GET /odata/DynamicContact?\$select=FirstName,LastName,Email&\$filter=LastName eq 'Muster'"

tipp

Verwenden Sie $select, um die Antwortgröße zu reduzieren – insbesondere bei DynamicContact, wo benutzerdefinierte Felder die Antwort erheblich vergrößern können.