Categories & Master Data

This page documents master data entities used across InLoox: categories, clients, project and task statuses, notes, templates, related items, and user stopwatches.

Category

Categories are used to classify and organize projects.

Properties

Property	Type	Description
CategoryId	guid	Unique identifier of the category.
Name	string	Display name of the category.

Endpoints

GET/odata/Category

Returns all categories. Supports OData query options.

GET/odata/Category/$count

Returns the total number of categories.

GET/odata/Category({key})

Returns a single category by its ID.

Parameter	Type	Required	Description
key	guid	✅	The CategoryId.

POST/odata/Category

Creates a new category.

{
  "Name": "Marketing"
}

PATCH/odata/Category({key})

Partially updates an existing category.

Parameter	Type	Required	Description
key	guid	✅	The CategoryId.

DELETE/odata/Category({key})

Deletes a category.

Parameter	Type	Required	Description
key	guid	✅	The CategoryId.

---

Client

Clients represent external organizations or customers associated with projects.

Properties

Property	Type	Description
ClientId	guid	Unique identifier of the client.
Name	string	Client name.
NumberPrefix	string	Prefix for generated client numbers.
NumberIncremential	int32	Auto-incrementing number used in client number generation.
NumberSuffix	string	Suffix for generated client numbers.
Number	string	Full formatted client number (composed from prefix, incremental, and suffix).

Endpoints

GET/odata/Client

Returns all clients. Supports OData query options.

GET/odata/Client/$count

Returns the total number of clients.

GET/odata/Client({key})

Returns a single client by its ID.

Parameter	Type	Required	Description
key	guid	✅	The ClientId.

POST/odata/Client

Creates a new client.

{
  "Name": "Acme Corp",
  "NumberPrefix": "CLI-",
  "NumberSuffix": ""
}

PATCH/odata/Client({key})

Partially updates an existing client.

Parameter	Type	Required	Description
key	guid	✅	The ClientId.

DELETE/odata/Client({key})

Deletes a client.

Parameter	Type	Required	Description
key	guid	✅	The ClientId.

---

ProjectStatus

Project statuses define the lifecycle stages of a project (e.g., Planning, Active, Closed).

Properties

Property	Type	Description
ProjectStatusId	guid	Unique identifier of the project status.
Name	string	Display name of the status.
Progress	double	Progress value from 0 to 1 (e.g., 0.5 = 50%).
OrdinalPosition	int32	Display order in status lists.

Endpoints

GET/odata/ProjectStatus

Returns all project statuses. Supports OData query options.

GET/odata/ProjectStatus/$count

Returns the total number of project statuses.

GET/odata/ProjectStatus({key})

Returns a single project status by its ID.

Parameter	Type	Required	Description
key	guid	✅	The ProjectStatusId.

POST/odata/ProjectStatus

Creates a new project status.

{
  "Name": "In Progress",
  "Progress": 0.5,
  "OrdinalPosition": 2
}

PATCH/odata/ProjectStatus({key})

Partially updates an existing project status.

Parameter	Type	Required	Description
key	guid	✅	The ProjectStatusId.

DELETE/odata/ProjectStatus({key})

Deletes a project status.

Parameter	Type	Required	Description
key	guid	✅	The ProjectStatusId.

---

ProjectNote

Project notes store text annotations attached to a specific project.

Properties

Property	Type	Description
ProjectNoteId	guid	Unique identifier of the project note.
ProjectId	guid	Identifier of the parent project.
Note	string	Plain text content of the note.
NoteHtml	string	HTML formatted content of the note.
ShortDescription	string	Summary or title of the note.
CreateDateTime	DateTimeOffset	Timestamp when the note was created.
CreatedByContactId	guid	Identifier of the contact who authored the note.

Endpoints

GET/odata/ProjectNote

Returns all project notes. Supports OData query options.

GET/odata/ProjectNote/$count

Returns the total number of project notes.

GET/odata/ProjectNote({key})

Returns a single project note by its ID.

Parameter	Type	Required	Description
key	guid	✅	The ProjectNoteId.

POST/odata/ProjectNote

Creates a new project note.

{
  "ProjectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "ShortDescription": "Kickoff meeting summary",
  "Note": "Discussed project scope and timeline.",
  "NoteHtml": "<p>Discussed project scope and timeline.</p>"
}

PATCH/odata/ProjectNote({key})

Partially updates an existing project note.

Parameter	Type	Required	Description
key	guid	✅	The ProjectNoteId.

DELETE/odata/ProjectNote({key})

Deletes a project note.

Parameter	Type	Required	Description
key	guid	✅	The ProjectNoteId.

---

TaskStatus

Task statuses define the workflow states for tasks within a specific project.

info

TaskStatus entries are project-specific. Each project can define its own set of task statuses.

Properties

Property	Type	Description
TaskItemStatusId	guid	Unique identifier of the task status.
Name	string	Display name of the status.
ProjectId	guid	Identifier of the project this status belongs to.
OrdinalPosition	int32	Display order within the project's status list.
Color	string	Hex color code (e.g., #FF5733).

Endpoints

GET/odata/TaskStatus

Returns all task statuses. Supports OData query options.

Use $filter=ProjectId eq {projectId} to retrieve statuses for a specific project.

GET/odata/TaskStatus/$count

Returns the total number of task statuses.

GET/odata/TaskStatus({key})

Returns a single task status by its ID.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusId.

POST/odata/TaskStatus

Creates a new task status.

{
  "Name": "In Review",
  "ProjectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "OrdinalPosition": 3,
  "Color": "#FFA500"
}

PATCH/odata/TaskStatus({key})

Partially updates an existing task status.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusId.

DELETE/odata/TaskStatus({key})

Deletes a task status.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusId.

---

TaskItemStatusDefault

Default task statuses defined at the organization level. New projects inherit these defaults automatically.

note

TaskItemStatusDefault defines organization-wide default task statuses. New projects inherit these defaults.

Properties

Property	Type	Description
TaskItemStatusDefaultId	guid	Unique identifier of the default task status.
Name	string	Display name of the default status.
HexColor	string	Color code for the status (e.g., #28A745).
OrdinalPosition	int32	Display order in the default status list.

Endpoints

GET/odata/TaskItemStatusDefault

Returns all default task statuses. Supports OData query options.

GET/odata/TaskItemStatusDefault/$count

Returns the total number of default task statuses.

GET/odata/TaskItemStatusDefault({key})

Returns a single default task status by its ID.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusDefaultId.

POST/odata/TaskItemStatusDefault

Creates a new default task status.

{
  "Name": "To Do",
  "HexColor": "#007BFF",
  "OrdinalPosition": 1
}

PATCH/odata/TaskItemStatusDefault({key})

Partially updates an existing default task status.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusDefaultId.

DELETE/odata/TaskItemStatusDefault({key})

Deletes a default task status.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemStatusDefaultId.

---

TaskItemNote

Task item notes store text annotations attached to a specific task.

Properties

Property	Type	Description
TaskItemNoteId	guid	Unique identifier of the task note.
TaskItemId	guid	Identifier of the parent task.
Note	string	Plain text content of the note.
NoteHtml	string	HTML formatted content of the note.
ShortDescription	string	Summary or title of the note.
CreateDateTime	DateTimeOffset	Timestamp when the note was created.
CreatedByContactId	guid	Identifier of the contact who authored the note.

Endpoints

GET/odata/TaskItemNote

Returns all task item notes. Supports OData query options.

GET/odata/TaskItemNote/$count

Returns the total number of task item notes.

GET/odata/TaskItemNote({key})

Returns a single task item note by its ID.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemNoteId.

POST/odata/TaskItemNote

Creates a new task item note.

{
  "TaskItemId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "ShortDescription": "Blocker identified",
  "Note": "Waiting on external API access.",
  "NoteHtml": "<p>Waiting on external API access.</p>"
}

PATCH/odata/TaskItemNote({key})

Partially updates an existing task item note.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemNoteId.

DELETE/odata/TaskItemNote({key})

Deletes a task item note.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemNoteId.

---

TaskItemTemplate

Task item templates allow saving and reusing task structures across projects.

Properties

Property	Type	Description
TaskItemTemplateId	guid	Unique identifier of the template.
Name	string	Name of the template.

Endpoints

Standard CRUD

GET/odata/TaskItemTemplate

Returns all task item templates. Supports OData query options.

GET/odata/TaskItemTemplate/$count

Returns the total number of task item templates.

GET/odata/TaskItemTemplate({key})

Returns a single task item template by its ID.

Parameter	Type	Required	Description
key	guid	✅	The template ID.

POST/odata/TaskItemTemplate

Creates a new task item template.

PATCH/odata/TaskItemTemplate({key})

Partially updates an existing task item template.

Parameter	Type	Required	Description
key	guid	✅	The template ID.

DELETE/odata/TaskItemTemplate({key})

Deletes a task item template.

Parameter	Type	Required	Description
key	guid	✅	The template ID.

Template Operations

POST/odata/TaskItemTemplate/SaveTemplateForProject

Saves a project's current task structure as a reusable template.

{
  "ProjectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "TemplateName": "Standard Onboarding"
}

POST/odata/TaskItemTemplate({key})/LoadTemplateForProject

Loads a template's task structure into a target project.

{
  "TemplateId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "ProjectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

GET/odata/TaskItemTemplate({key})/DownloadTemplate()

Downloads a task item template as a file.

Parameter	Type	Required	Description
key	guid	✅	The TaskItemTemplate ID.

GET/odata/TaskItemTemplate/DownloadTaskItemTemplate(projectId={projectId})

Downloads a project's task structure as a template file.

Parameter	Type	Required	Description
projectId	guid	✅	The ID of the project whose tasks to export.

---

RelatedItem

RelatedItem is a read-only entity that retrieves cross-entity relationships.

info

RelatedItem is a read-only entity. The key identifies the source entity whose related items you want to retrieve.

Properties

Property	Type	Description
GenericObjectRelationId	guid	Unique identifier of the relation.
ResultType	string	Type of the related object.
RelatedObjectId	guid	ID of the related object.
UpdatedAt	datetime	Timestamp of the last update.
SecurityContactId	guid	Contact ID for permission check.
ProjectId	guid?	Associated project ID (if applicable).
ObjectId	guid	ID of the source object.
ParentObjectId	guid?	ID of the parent object.
Title	string	Title of the related object.
ImageId	guid?	Image ID of the related object.

Endpoints

GET/odata/RelatedItem({key})/GetRelatedItems()

Returns items related to the specified entity.

Parameter	Type	Required	Description
key	guid	✅	The ID of the source entity.

---

UserStopwatch

UserStopwatch provides access to the current user's active time-tracking stopwatches.

tip

UserStopwatch returns active time-tracking stopwatches. Use this to check if the user has any running timers before starting a new time entry.

Endpoints

GET/odata/UserStopwatch/GetStopwatches()

Returns all active stopwatches for the current user.