Organization & Master Data

This page describes the API endpoints for master data used across various areas of InLoox: categories, clients, project status, default task item status, templates, and other helper entities.

---

Category

The Category entity enables the categorization of projects. Categories can be freely defined and assigned.

Data Model

Property	Type	Description
CategoryId	guid	Unique ID of the category.
Name	string	Name of the category.

Endpoints

List all categories

GET/odata/Category

Supports OData query options.

---

Get a category by ID

GET/odata/Category({key})

Parameter	Type	Required	Description
key	guid	✅	The CategoryId.

---

Create a new category

POST/odata/Category

Parameter	Type	Required	Description
Body	Delta<ApiCategory>	✅	JSON object with the properties from the data model.

---

Update a category

PATCH/odata/Category({key})

Parameter	Type	Required	Description
key	guid	✅	The CategoryId.
Body	Delta<ApiCategory>	✅	JSON object with the fields to update.

---

Delete a category

DELETE/odata/Category({key})

Parameter	Type	Required	Description
key	guid	✅	The CategoryId.

warning

Deleting a category removes it from all projects that use it. This action cannot be undone.

Returns 204 No Content on success.

---

Client

The Client entity represents clients in InLoox. Clients can be assigned to projects and feature automatic numbering.

Data Model

Property	Type	Description
ClientId	guid	Unique ID of the client.
Name	string	Client name.
NumberPrefix	string	Prefix of the client number.
NumberIncremential	int?	Automatically incremented part of the client number.
NumberSuffix	string	Suffix of the client number.
Number	string	Full client number (prefix + increment + suffix).

Endpoints

List all clients

GET/odata/Client

Supports OData query options.

---

Get a client by ID

GET/odata/Client({key})

Parameter	Type	Required	Description
key	guid	✅	The ClientId.

---

Create a new client

POST/odata/Client

Parameter	Type	Required	Description
Body	Delta<ApiClient>	✅	JSON object with the properties from the data model.

tip

The client number is generated automatically when the number settings are enabled in the configuration. Use odata/Configuration/GetClientNumberSettings() to retrieve the current configuration.

---

Update a client

PATCH/odata/Client({key})

Parameter	Type	Required	Description
key	guid	✅	The ClientId.
Body	Delta<ApiClient>	✅	JSON object with the fields to update.

---

Delete a client

DELETE/odata/Client({key})

Parameter	Type	Required	Description
key	guid	✅	The ClientId.

warning

Deleting a client removes it from all assigned projects. This action cannot be undone.

Returns 204 No Content on success.

---

Division

The Division entity enables the hierarchical organizational structure in InLoox. Divisions can be nested and have contacts assigned to them. Users can receive permissions on projects that have specific divisions assigned.

Data Model

Property	Type	Description
DivisionId	guid	Unique ID of the division.
ParentDivisionId	guid?	ID of the parent division (null for root level).
DisplayName	string	Display name of the division.
PositionNumber	int	Sort position.
Description	string	Description of the division.

Endpoints

CRUD Operations

List all divisions

GET/odata/Division

Supports OData query options.

---

Get a division by ID

GET/odata/Division({key})

Parameter	Type	Required	Description
key	guid	✅	The DivisionId of the division to retrieve.

---

Create a new division

POST/odata/Division

Parameter	Type	Required	Description
Body	Delta<ApiDivision>	✅	JSON object with the properties from the data model.

tip

Omit DivisionId to let the server automatically generate a new ID. Set ParentDivisionId to create a sub-division.

---

Update an existing division

PATCH/odata/Division({key})

Parameter	Type	Required	Description
key	guid	✅	The DivisionId of the division to update.
Body	Delta<ApiDivision>	✅	JSON object with the fields to update.

---

Delete a division

DELETE/odata/Division({key})

Parameter	Type	Required	Description
key	guid	✅	The DivisionId of the division to delete.

Returns 204 No Content on success.

warning

Deleting a division also removes all contact assignments for that division. Since permissions can also be granted at the division level, users may lose access to projects.

---

Contact Management

List all contacts with division assignments

GET/odata/Division/GetContacts()

Returns all DivisionContactRelation entries.

---

Assign a contact to a division

POST/odata/Division({key})/AddContact

Parameter	Type	Required	Description
key	guid	✅	The DivisionId.
Body	object	✅	JSON object with the following fields: ContactId (guid, required) — The contact to assign.

---

Remove a contact from a division

POST/odata/Division({key})/RemoveContact

Parameter	Type	Required	Description
key	guid	✅	The DivisionId.
Body	object	✅	JSON object with the following fields: ContactId (guid, required) — The contact to remove.

---

DivisionContactRelation

The DivisionContactRelation entity represents the assignment between divisions and contacts. Each assignment links exactly one contact to a division.

note

This entity is read-only. To manage the assignment of divisions and contacts, use the AddContact and RemoveContact actions on the Division entity.

Data Model

Property	Type	Description
DivisionContactRelationId	guid	Unique ID of the assignment.
DivisionId	guid	ID of the division.
ContactId	guid	ID of the contact.

Endpoints

List all division-contact assignments for all contacts

GET/odata/DivisionContactRelation

Supports OData query options.

Filter by division or contact:

GET /odata/DivisionContactRelation?$filter=DivisionId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

---

Get a single assignment by ID

GET/odata/DivisionContactRelation({key})

Parameter	Type	Required	Description
key	guid	✅	The DivisionContactRelationId.

---

ProjectStatus

The ProjectStatus entity defines the available status values for projects. Each status has a name, a progress value, and a sort position.

Data Model

Property	Type	Description
ProjectStatusId	guid	Unique ID of the project status.
Name	string	Name of the status (e.g. Active, Completed, Paused).
Progress	int	Progress value in percent (0–100).
OrdinalPosition	int	Sort position.

Endpoints

List all project statuses

GET/odata/ProjectStatus

---

Get a project status by ID

GET/odata/ProjectStatus({key})

Parameter	Type	Required	Description
key	guid	✅	The ProjectStatusId.

---

Create a new project status

POST/odata/ProjectStatus

Parameter	Type	Required	Description
Body	Delta<ApiProjectStatus>	✅	JSON object with the properties from the data model.

---

Update a project status

PATCH/odata/ProjectStatus({key})

Parameter	Type	Required	Description
key	guid	✅	The ProjectStatusId.
Body	Delta<ApiProjectStatus>	✅	JSON object with the fields to update.

---

Delete a project status

DELETE/odata/ProjectStatus({key})

Parameter	Type	Required	Description
key	guid	✅	The ProjectStatusId.

warning

Deleting a project status affects all projects that use it. This action cannot be undone.

Returns 204 No Content on success.

---

Skill

The Skill entity manages skills (also referred to as competencies) that can be assigned to contacts. This enables simplified resource planning and selection of responsible persons based on freely definable attributes.

Data Model

Property	Type	Description
SkillId	guid	Unique ID of the skill.
Name	string	Name of the skill.
Description	string	Description of the skill.

Endpoints

CRUD Operations

List all skills

GET/odata/Skill

Supports OData query options.

---

Get a skill by ID

GET/odata/Skill({key})

Parameter	Type	Required	Description
key	guid	✅	The SkillId.

---

Create a new skill

POST/odata/Skill

Parameter	Type	Required	Description
Body	Delta<ApiSkill>	✅	JSON object with the properties from the data model.

---

Update an existing skill

PATCH/odata/Skill({key})

Parameter	Type	Required	Description
key	guid	✅	The SkillId of the skill to update.
Body	Delta<ApiSkill>	✅	JSON object with the fields to update.

---

Delete a skill

DELETE/odata/Skill({key})

Parameter	Type	Required	Description
key	guid	✅	The SkillId of the skill to delete.

Returns 204 No Content on success.

warning

Deleting a skill removes all contact assignments for that skill.

---

Contact Assignments

List all contacts with skill assignments

GET/odata/Skill/GetContacts()

Returns all contact-skill assignments.

---

Get contacts for a specific skill

GET/odata/Skill({key})/GetSkillContacts()

Parameter	Type	Required	Description
key	guid	✅	The SkillId.

---

Assign a contact to a skill

POST/odata/Skill({key})/AddContact

Parameter	Type	Required	Description
key	guid	✅	The SkillId.
Body	object	✅	JSON object with the following fields: ContactId (guid, required) — The contact to assign.

---

Remove a contact from a skill

POST/odata/Skill({key})/RemoveContact

Parameter	Type	Required	Description
key	guid	✅	The SkillId.
Body	object	✅	JSON object with the following fields: ContactId (guid, required) — The contact to remove.

---

TaskItemStatusDefault

The TaskItemStatusDefault entity defines the organization-wide default statuses for Kanban tasks.

info

New projects automatically inherit these default values.

Data Model

Property	Type	Description
TaskItemStatusDefaultId	guid	Unique ID of the default status.
Name	string	Name of the default status.
HexColor	string	Color value as hex code (e.g. #FF0000).
OrdinalPosition	int	Sort position.

Endpoints

List all default task item statuses

GET/odata/TaskItemStatusDefault

---

Get a default task item status by ID

GET/odata/TaskItemStatusDefault({key})

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusDefaultId.

---

Create a new default task item status

POST/odata/TaskItemStatusDefault

Parameter	Type	Required	Description
Body	Delta<ApiTaskItemStatusDefault>	✅	JSON object with the properties from the data model.

---

Update a default task item status

PATCH/odata/TaskItemStatusDefault({key})

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusDefaultId.
Body	Delta<ApiTaskItemStatusDefault>	✅	JSON object with the fields to update.

---

Delete a default task item status

DELETE/odata/TaskItemStatusDefault({key})

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusDefaultId.

warning

Deleting a default task item status only affects the default values inherited by new projects. Existing projects are not affected.

Returns 204 No Content on success.

---