User
User / Users
The entity represents a system user. The account is stored separately from profile information (name, contacts, organizational data) and user settings (language, time zone, theme, date format).
The service is split into two endpoints: User — write operations; Users — collection queries and related reference objects. The User service does not expose its own OData single-record endpoint — both lists and individual records are read through Users.
User keys
| Key | Description |
|---|---|
| UserID | Internal account identifier |
| EmployeeID | Employee identifier (used for HR integrations) |
| Email address | |
| IntegrationID | External identifier from an integrated system |
Base URL
https://<host>/api/v01/User https://<host>/api/v01/Users
Endpoint map
| Method | URL | Purpose | Transport |
|---|---|---|---|
| GET | /api/v01/Users/odata/Users | Account list | OData |
| GET | /api/v01/Users/odata/UserProfiles | User profiles | OData |
| GET | /api/v01/Users/odata/UsersSettings | User settings | OData |
| GET | /api/v01/Users/odata/UserProfilesAccountSettings | Profile field metadata (editability, etc.) | OData |
| GET | /api/v01/Users/odata/Themes | UI themes | OData |
| GET | /api/v01/Users/odata/DateFormats | Date formats | OData |
| GET | /api/v01/Users/odata/TimeFormats | Time formats | OData |
| GET | /api/v01/Users/odata/TimeZones | Time zones | OData |
| GET | /api/v01/Users/odata/StartWeekOns | Week start days | OData |
| GET | /api/v01/Users/odata/Countries | Countries | OData |
| GET | /api/v01/Users/odata/Spaces | Spaces available to the user | OData |
| POST | /api/v01/User/rest/Create | Create a user | REST |
| POST | /api/v01/User/rest/UpdateProfile | Update a user profile | REST |
| POST | /api/v01/User/rest/UpdateSettings | Update user settings | REST |
| POST | /api/v01/User/rest/Activate | Activate a user | REST |
| POST | /api/v01/User/rest/Deactivate | Deactivate a user | REST |