Configuration & Permissions

These entity sets manage organization-wide configuration, user and role permissions, saved views, notification settings, and domain restrictions. Configuration endpoints control system behavior across the entire InLoox organization.

warning

Configuration changes affect all users in the organization. Use caution when modifying these settings via the API.

---

Configuration

The Configuration entity stores key-value pairs that control organization-wide settings such as notification preferences, document storage, and numbering schemes.

Properties

Property	Type	Description
ConfigurationId	guid	Unique identifier of the configuration entry.
Key	string	Configuration key.
Value	string	Configuration value.

Endpoints

List Configuration Entries

GET/odata/Configuration

Returns all configuration entries. Supports OData query options.

GET /odata/Configuration?$filter=contains(Key,'Notification')

Count Configuration Entries

GET/odata/Configuration/$count

Returns the total number of configuration entries.

Get Configuration Entry

GET/odata/Configuration({key})

Returns a single configuration entry by its key.

Parameter	Type	Required	Description
key	string	✅	The configuration key identifier.

Create Configuration Entry

POST/odata/Configuration

Creates a new configuration entry.

{
  "Key": "CustomSetting",
  "Value": "enabled"
}

Update Configuration Entry

PATCH/odata/Configuration({key})

Partially updates an existing configuration entry.

Parameter	Type	Required	Description
key	string	✅	The configuration key identifier.

Delete Configuration Entry

DELETE/odata/Configuration({key})

Deletes a configuration entry.

Parameter	Type	Required	Description
key	string	✅	The configuration key identifier.

Functions

Get Organization Settings

GET/odata/Configuration/GetOrganizationSettings()

Returns organization-wide settings.

Get Notification Settings

GET/odata/Configuration/GetNotificationSettings()

Returns notification configuration settings.

Get Document Settings

GET/odata/Configuration/GetDocumentSettings()

Returns document storage configuration.

Get Client Number Settings

GET/odata/Configuration/GetClientNumberSettings()

Returns client number configuration (format, prefix, counter).

Get Project Number Settings

GET/odata/Configuration/GetProjectNumberSettings()

Returns project number configuration (format, prefix, counter).

Actions

Update Configuration by Key

POST/odata/Configuration/UpdateConfigByKey

Updates a configuration entry by its key name.

{
  "Key": "CustomSetting",
  "Value": "disabled"
}

Set Default Document Store

POST/odata/Configuration/SetDocumentDefaultStore

Sets the default document storage provider for the organization.

Set Notify Contacts Without Login

POST/odata/Configuration/SetNotifyContactsWithoutLogin

Configures whether contacts without a login receive notifications.

---

UserPermission

The UserPermission entity manages permissions assigned directly to individual users.

Properties

Property	Type	Description
Id	guid	Unique identifier.
UserPermissionId	guid	Permission ID.
ContactIds	Collection(guid)	List of associated contact IDs.
DivisionIds	Collection(guid)	List of associated division IDs.
ProjectRead	boolean	Read projects.
ProjectModify	boolean	Edit projects.
ProjectDelete	boolean	Delete projects.
ProjectLock	boolean	Lock projects.
ProjectMemberModify	boolean	Manage project members.
ProjectCreate	boolean	Create projects.
TaskItemAccess	boolean	View tasks.
TaskItemModify	boolean	Edit tasks.
TaskItemDelete	boolean	Delete tasks.
TimeEntryAccess	boolean	View time entries.
TimeEntryModify	boolean	Edit time entries.
DocumentAccess	boolean	View documents.
DocumentModify	boolean	Edit documents.
BudgetAccess	boolean	View budgets.
BudgetModify	boolean	Edit budgets.
PlanningAccess	boolean	View planning.
PlanningModify	boolean	Edit planning.
MindMapAccess	boolean	View mind maps.
MindMapModify	boolean	Edit mind maps.
CheckListAccess	boolean	View checklists.
CheckListModify	boolean	Edit checklists.
PermissionsAdministrate	boolean	Administer permissions.
ManageAccess	boolean	Management access.
ManageModify	boolean	Management rights.
ReadOnlyLicense	boolean	Read-only license.
PrivateTasksCreate	boolean	Create private tasks.
PATAccess	boolean	Use Personal Access Tokens.
PortfoliosModify	boolean	Edit portfolios.
RiskAccess	boolean	View risks.
RiskModify	boolean	Edit risks.
DashboardsAccess	boolean	View dashboards.
DashboardsModify	boolean	Edit dashboards.
ContactsModify	boolean	Edit contacts.

info

The table above shows a selection of the most important permission flags. The complete list includes additional granular permissions such as OwnTaskItemAccess, TaskItemStateModify, TaskItemCommentAdd, ReportRead, ReportModify, FreeTimeEntryModify, and others.

Endpoints

List User Permissions

GET/odata/UserPermission

Returns all user permissions. Supports OData query options.

GET /odata/UserPermission?$filter=UserId eq {userId}

Count User Permissions

GET/odata/UserPermission/$count

Returns the total number of user permission entries.

Create or Update User Permission

POST/odata/UserPermission

Creates or updates a user permission entry.

{
  "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "PermissionType": 1,
  "IsGranted": true
}

Functions

Get Current User's Permission Set

GET/odata/UserPermission/MyGlobalUserPermissionSet()

Returns the complete permission set for the currently authenticated user.

---

RolePermission

The RolePermission entity manages permissions assigned to roles. Users inherit these permissions through their role assignments.

Properties

Property	Type	Description
RoleType	int32	Role type identifier.
RoleEnabled	boolean	Whether the role is enabled.
CustomName	string	Custom role name.

Endpoints

List Role Permissions

GET/odata/RolePermission

Returns all role permissions. Supports OData query options.

GET /odata/RolePermission?$filter=RoleId eq {roleId}

Count Role Permissions

GET/odata/RolePermission/$count

Returns the total number of role permission entries.

Update Role Permission

PATCH/odata/RolePermission({key})

Updates an existing role permission.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the role permission.

---

View

The View entity manages saved views that define column layouts, filters, and sort orders for data grids. Views can be user-specific or shared across the organization.

Properties

Property	Type	Description
ViewId	guid	Unique identifier of the view.
ContactId	guid	ID of the view owner.
Name	string	Name of the view.
IsGlobal	boolean	Whether the view is visible to all users.
Type	int32	View type (e.g., project list, task list).
DataSourceType	int32	Data source type of the view.
ProjectId	guid?	Optional project ID (for project-specific views).

Endpoints

List Views

GET/odata/View

Returns all views. Supports OData query options.

GET /odata/View?$filter=DatasourceType eq 'Project'

Count Views

GET/odata/View/$count

Returns the total number of views.

Get View

GET/odata/View({key})

Returns a single view by its ID.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the view.

Create View

POST/odata/View

Creates a new view.

{
  "Name": "My Project View",
  "DatasourceType": "Project",
  "IsShared": false
}

Update View

PATCH/odata/View({key})

Partially updates an existing view.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the view.

Delete View

DELETE/odata/View({key})

Deletes a view.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the view.

Actions & Functions

Select View

GET/odata/View({key})/SelectView()

Sets the active view for the current user.

Parameter	Type	Required	Description
key	Guid	✅	The ViewId.

Restore Default Views

GET/odata/View/RestoreDefaultViews(viewType={viewType})

Restores all views to their default configuration for the specified view type.

Parameter	Type	Required	Description
viewType	int32	✅	The view type to restore defaults for.

warning

This action resets all custom views for the current user. This cannot be undone.

Get Selected View

GET/odata/View/GetSelectedView(viewType={viewType})

Returns the currently selected view for the authenticated user.

Parameter	Type	Required	Description
viewType	int32	✅	The view type.

Get Selected View by Data Source Type

GET/odata/View/GetSelectedViewByDatasourceType(viewType={viewType},viewDatasourceType={viewDatasourceType})

Returns the selected view filtered by view type and data source type.

Parameter	Type	Required	Description
viewType	int32	✅	The view type.
viewDatasourceType	int32	✅	The data source type.

Save View Data

POST/odata/View({key})/SaveViewData

Saves view layout and column configuration.

Parameter	Type	Required	Description
key	Guid	✅	The ViewId.

Download View

GET/odata/View({key})/DownloadView()

Downloads a view configuration as a file.

Parameter	Type	Required	Description
key	Guid	✅	The ViewId.

Delete Project Dashboard

POST/odata/View/DeleteProjectDashboard

Deletes a project-level dashboard.

Delete Organization Default Dashboard

POST/odata/View/DeleteOrganizationDefaultDashboard

Deletes the organization-wide default dashboard.

---

NotificationFilterSetting

The NotificationFilterSetting entity controls per-user notification filter rules, determining which events trigger notifications.

Properties

Property	Type	Description
NotificationFilterSettingId	guid	Unique identifier of the filter setting.
EntityPath	string	Entity path the filter applies to (e.g., Project, TaskItem).
Enabled	boolean	Whether the notification is enabled.
Channel	string	Notification channel (e.g., Email, Push).

Endpoints

List Notification Filter Settings

GET/odata/NotificationFilterSetting

Returns all notification filter settings. Supports OData query options.

Count Notification Filter Settings

GET/odata/NotificationFilterSetting/$count

Returns the total number of notification filter settings.

Get Notification Filter Setting

GET/odata/NotificationFilterSetting({key})

Returns a single notification filter setting by its ID.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the notification filter setting.

Actions

Create or Update Notification Filter

POST/odata/NotificationFilterSetting/CreateOrUpdate

Creates a new notification filter setting or updates an existing one.

---

NotificationObjectRelation

The NotificationObjectRelation entity represents the link between notification settings and the objects they apply to (e.g., projects, tasks).

info

NotificationObjectRelation is a read-only entity. It represents the mapping between notification settings and their associated objects and cannot be modified directly.

Endpoints

GET/odata/NotificationObjectRelation

Returns all notification object relations. Supports OData query options.

GET/odata/NotificationObjectRelation/$count

Returns the total number of notification object relations.

GET/odata/NotificationObjectRelation({key})

Returns a single notification object relation by its ID.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the notification object relation.

---

ValidInviteDomain

The ValidInviteDomain entity restricts which email domains can be used when inviting new users to the organization. Only email addresses matching a configured domain will be accepted.

Properties

Property	Type	Description
ValidInviteDomainId	guid	Unique identifier of the domain entry.
DomainName	string	The domain name (e.g., example.com).

Endpoints

GET/odata/ValidInviteDomain

Returns all valid invite domains.

GET/odata/ValidInviteDomain/$count

Returns the total number of valid invite domains.

GET/odata/ValidInviteDomain({key})

Returns a single valid invite domain by its ID.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the invite domain entry.

POST/odata/ValidInviteDomain

Creates a new valid invite domain.

{
  "DomainName": "example.com"
}

PATCH/odata/ValidInviteDomain({key})

Updates an existing valid invite domain.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the invite domain entry.

DELETE/odata/ValidInviteDomain({key})

Deletes a valid invite domain.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the invite domain entry.

---

ValidLoginDomain

The ValidLoginDomain entity restricts which email domains are allowed to authenticate with the organization. Users whose email domain is not in this list will be denied login.

Properties

Property	Type	Description
ValidLoginDomainId	guid	Unique identifier of the domain entry.
DomainName	string	The domain name (e.g., example.com).

Endpoints

GET/odata/ValidLoginDomain

Returns all valid login domains.

GET/odata/ValidLoginDomain/$count

Returns the total number of valid login domains.

GET/odata/ValidLoginDomain({key})

Returns a single valid login domain by its ID.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the login domain entry.

POST/odata/ValidLoginDomain

Creates a new valid login domain.

{
  "DomainName": "example.com"
}

PATCH/odata/ValidLoginDomain({key})

Updates an existing valid login domain.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the login domain entry.

DELETE/odata/ValidLoginDomain({key})

Deletes a valid login domain.

Parameter	Type	Required	Description
key	Guid	✅	The unique identifier of the login domain entry.

tip

Configure both ValidInviteDomain and ValidLoginDomain to enforce consistent domain policies. Invite domains control who can be added, while login domains control who can authenticate.