Fields

Fields

Fields of the user-related OData collections: Users, UserProfiles, UsersSettings.


Users

GET /api/v01/Users/odata/Users?$format=json


FieldTypeDescription
UserIDNVARCHARIdentifier
UserNameNVARCHARLogin name (equals UserID)
VersionNVARCHARRecord version ('A' — active)
DateFromDATEAccount valid-from date
DateToDATEAccount valid-to date
EmailNVARCHAREmail
EmployeeIDNVARCHAREmployee identifier
AvatarURLNVARCHAR(2083)Avatar URL
UserFirstNameNVARCHARFirst name
UserLastNameNVARCHARLast name
UserFullNameNVARCHAR(121)Full name (First Last)
UserShortNameNVARCHAR(63)Short name (F.Last)
UserNameShortNVARCHAR(63)Alternative short format (Last F.)
UserAboutMeNVARCHAR"About me"
UserDefaultLanguageNVARCHAR(5)Default UI language
SQLCallMonthLimit, SQLCallMonthNUMBERMonthly SQL call limits
SQLCallDayLimit, SQLCallDayNUMBERDaily SQL call limits
SQLCallHourLimit, SQLCallHourNUMBERHourly SQL call limits
LockRecordTimeout, BlockRecordTimeoutNUMBERRecord lock timeouts
LockCodeNVARCHARAccount lock code
LogSQLCallOff_INVARCHAR(1)SQL logging-off flag
ActivityCallOff_INVARCHAR(1)Activity-off flag
Created, CreatedBySECONDDATE / NVARCHARWho created and when
Modified, ModifiedBySECONDDATE / NVARCHARWho modified and when
IntegrationIDNVARCHARExternal ID


UserProfiles

Extended user card: contacts, organizational details, field publicity flags.

GET /api/v01/Users/odata/UserProfiles?$format=json


FieldTypeDescription
UserIDNVARCHARUser identifier (key)
VersionNVARCHARRecord version
EmployeeIDNVARCHAREmployee ID
EmailNVARCHAREmail
EmailPublic_FNVARCHAR(1)Email is public ('X' / empty)
DateFrom, DateToDATEValidity period
AvatarURL, AvatarURLLarge, AvatarURL24, AvatarURL16NVARCHARAvatars of different sizes
AvatarURLPublic_FNVARCHAR(1)Avatars are public
UserFirstName, UserFirstNamePublic_FNVARCHARFirst name and publicity flag
UserLastName, UserLastNamePublic_FNVARCHARLast name and flag
UserFullNameNVARCHAR(121)Denormalized full name
UserAboutMe, UserAboutMePublic_FNVARCHAR"About me" and flag
OrgInfoCustom_FNVARCHAR(1)Organizational info set manually
UserCanChangePublic_FNVARCHAR(1)Whether the user can change publicity flags themselves
Skype, SkypePublic_FNVARCHARSkype
Telegram, TelegramPublic_FNVARCHARTelegram
OtherMessenger, OtherMessengerPublic_FNVARCHAROther messenger
Phone, PhonePublic_FNVARCHARPhone
CountryID, CountryText, CountryPublic_FNVARCHARCountry
City, CityPublic_FNVARCHARCity
PostalAddress, PostalAddressPublic_FNVARCHARPostal address
JobTitleText, JobTitleTextPublic_FNVARCHARJob title
OrgUnitText, OrgUnitTextPublic_FNVARCHAROrg unit
LineOfBusinessText, LineOfBusinessTextPublic_FNVARCHARLine of business
CompanyText, CompanyTextPublic_FNVARCHARCompany
WorkOfficeText, WorkOfficeTextPublic_FNVARCHAROffice
SendChangeNotificationToNVARCHARWhere to send profile-change notifications
Created, CreatedBy, CreatedByFullName, CreatedByAvatar—Creation audit
Modified, ModifiedBy, ModifiedByFullName, ModifiedByAvatar—Modification audit
IntegrationIDNVARCHARExternal ID


UsersSettings

User UI and localization settings.

GET /api/v01/Users/odata/UsersSettings?$format=json


FieldTypeDescription
UserIDNVARCHARIdentifier
AvatarURL, AvatarURLLarge, AvatarURL24, AvatarURL16NVARCHARAvatars
UserAboutMeNVARCHAR"About me"
Email, EmailPublic_FNVARCHAREmail and publicity flag
UserFullNameNVARCHAR(121)Full name
DefaultLanguageNVARCHARUI language
DetectLocation, DetectLocationMandatoryNVARCHAR(1)Location detection flags
TimeZoneID, TimeZoneIDPublic_FNVARCHARTime zone and publicity flag
TimeOffsetSecondsINTEGERTime zone offset in seconds
DateFormatIDNVARCHARDate format
TimeFormatIDNVARCHARTime format
StartWeekOnIDNVARCHARFirst day of the week
ThemeIDNVARCHARUI theme
FullWidth_FNVARCHAR(1)Full-width layout
IntegrationIDNVARCHARExternal ID