Fields
Fields
Fields of the user-related OData collections: Users, UserProfiles, UsersSettings.
Users
GET /api/v01/Users/odata/Users?$format=json
| Field | Type | Description |
|---|---|---|
| UserID | NVARCHAR | Identifier |
| UserName | NVARCHAR | Login name (equals UserID) |
| Version | NVARCHAR | Record version ('A' — active) |
| DateFrom | DATE | Account valid-from date |
| DateTo | DATE | Account valid-to date |
| NVARCHAR | ||
| EmployeeID | NVARCHAR | Employee identifier |
| AvatarURL | NVARCHAR(2083) | Avatar URL |
| UserFirstName | NVARCHAR | First name |
| UserLastName | NVARCHAR | Last name |
| UserFullName | NVARCHAR(121) | Full name (First Last) |
| UserShortName | NVARCHAR(63) | Short name (F.Last) |
| UserNameShort | NVARCHAR(63) | Alternative short format (Last F.) |
| UserAboutMe | NVARCHAR | "About me" |
| UserDefaultLanguage | NVARCHAR(5) | Default UI language |
| SQLCallMonthLimit, SQLCallMonth | NUMBER | Monthly SQL call limits |
| SQLCallDayLimit, SQLCallDay | NUMBER | Daily SQL call limits |
| SQLCallHourLimit, SQLCallHour | NUMBER | Hourly SQL call limits |
| LockRecordTimeout, BlockRecordTimeout | NUMBER | Record lock timeouts |
| LockCode | NVARCHAR | Account lock code |
| LogSQLCallOff_I | NVARCHAR(1) | SQL logging-off flag |
| ActivityCallOff_I | NVARCHAR(1) | Activity-off flag |
| Created, CreatedBy | SECONDDATE / NVARCHAR | Who created and when |
| Modified, ModifiedBy | SECONDDATE / NVARCHAR | Who modified and when |
| IntegrationID | NVARCHAR | External ID |
UserProfiles
Extended user card: contacts, organizational details, field publicity flags.
GET /api/v01/Users/odata/UserProfiles?$format=json
| Field | Type | Description |
|---|---|---|
| UserID | NVARCHAR | User identifier (key) |
| Version | NVARCHAR | Record version |
| EmployeeID | NVARCHAR | Employee ID |
| NVARCHAR | ||
| EmailPublic_F | NVARCHAR(1) | Email is public ('X' / empty) |
| DateFrom, DateTo | DATE | Validity period |
| AvatarURL, AvatarURLLarge, AvatarURL24, AvatarURL16 | NVARCHAR | Avatars of different sizes |
| AvatarURLPublic_F | NVARCHAR(1) | Avatars are public |
| UserFirstName, UserFirstNamePublic_F | NVARCHAR | First name and publicity flag |
| UserLastName, UserLastNamePublic_F | NVARCHAR | Last name and flag |
| UserFullName | NVARCHAR(121) | Denormalized full name |
| UserAboutMe, UserAboutMePublic_F | NVARCHAR | "About me" and flag |
| OrgInfoCustom_F | NVARCHAR(1) | Organizational info set manually |
| UserCanChangePublic_F | NVARCHAR(1) | Whether the user can change publicity flags themselves |
| Skype, SkypePublic_F | NVARCHAR | Skype |
| Telegram, TelegramPublic_F | NVARCHAR | Telegram |
| OtherMessenger, OtherMessengerPublic_F | NVARCHAR | Other messenger |
| Phone, PhonePublic_F | NVARCHAR | Phone |
| CountryID, CountryText, CountryPublic_F | NVARCHAR | Country |
| City, CityPublic_F | NVARCHAR | City |
| PostalAddress, PostalAddressPublic_F | NVARCHAR | Postal address |
| JobTitleText, JobTitleTextPublic_F | NVARCHAR | Job title |
| OrgUnitText, OrgUnitTextPublic_F | NVARCHAR | Org unit |
| LineOfBusinessText, LineOfBusinessTextPublic_F | NVARCHAR | Line of business |
| CompanyText, CompanyTextPublic_F | NVARCHAR | Company |
| WorkOfficeText, WorkOfficeTextPublic_F | NVARCHAR | Office |
| SendChangeNotificationTo | NVARCHAR | Where to send profile-change notifications |
| Created, CreatedBy, CreatedByFullName, CreatedByAvatar | — | Creation audit |
| Modified, ModifiedBy, ModifiedByFullName, ModifiedByAvatar | — | Modification audit |
| IntegrationID | NVARCHAR | External ID |
UsersSettings
User UI and localization settings.
GET /api/v01/Users/odata/UsersSettings?$format=json
| Field | Type | Description |
|---|---|---|
| UserID | NVARCHAR | Identifier |
| AvatarURL, AvatarURLLarge, AvatarURL24, AvatarURL16 | NVARCHAR | Avatars |
| UserAboutMe | NVARCHAR | "About me" |
| Email, EmailPublic_F | NVARCHAR | Email and publicity flag |
| UserFullName | NVARCHAR(121) | Full name |
| DefaultLanguage | NVARCHAR | UI language |
| DetectLocation, DetectLocationMandatory | NVARCHAR(1) | Location detection flags |
| TimeZoneID, TimeZoneIDPublic_F | NVARCHAR | Time zone and publicity flag |
| TimeOffsetSeconds | INTEGER | Time zone offset in seconds |
| DateFormatID | NVARCHAR | Date format |
| TimeFormatID | NVARCHAR | Time format |
| StartWeekOnID | NVARCHAR | First day of the week |
| ThemeID | NVARCHAR | UI theme |
| FullWidth_F | NVARCHAR(1) | Full-width layout |
| IntegrationID | NVARCHAR | External ID |