Skip to main content

InLoox API Reference

The InLoox API is an OData v4–compatible REST API that gives you programmatic access to your InLoox data — projects, tasks, time entries, budgets, documents, and more. Use it to build custom integrations, automate workflows, or synchronize InLoox with other systems.

Quick Start

New to the API? Head to the Getting Started guide to set up authentication and make your first request in minutes.



Base URLs

Use the appropriate base URL depending on your InLoox deployment:

InLoox Cloud:

https://app.inloox.com/api/odata/

InLoox Self-Hosted:

https://YOUR-SELF-HOSTED-URL/api/v1/odata/
info

All endpoint paths in this documentation are relative to the base URL above. For example, Project means https://app.inloox.com/api/odata/Project for Cloud users.


Authentication

The InLoox API uses Personal Access Tokens for authentication. Include your token in every request via the x-api-key HTTP header:

GET /api/odata/Project HTTP/1.1
Host: app.inloox.com
x-api-key: YOUR_API_TOKEN

For full details on obtaining and using tokens, see the Getting Started guide.


Available Entities

The API exposes the following entity groups. Click a group name for detailed documentation.

GroupKey EndpointsDescription
ProjectsProject, ProjectNote, ProjectStatus, DynamicProjectCreate, read, update, and delete projects. Manage members, categories, groups, and favorites.
TasksTask, TaskItemNote, TaskStatus, DynamicTaskItemManage project tasks and private tasks. Assign contributors, track status, and use stopwatch.
Time EntriesTimeEntry, TimeEntryComment, DynamicTimeEntryRecord and query time tracking data. Copy entries and add notes.
Budget & Line ItemsBudget, LineItem, BudgetGroup, BudgetPresetFinancial tracking — budgets, line items, invoicing, and templates.
DocumentsDocument, DocumentFolder, DocumentFolderStructureFile management — upload, link, organize with folders, track favorites.
PlanningPlanning, PlanningPublication, PlanningTemplateGantt chart elements — scheduling, dependencies, snapshots, and backward scheduling.
Mind MapsMindMap, MindMapNode, MindMapTemplateCreate and manage mind maps with nodes. Copy nodes to tasks or timeline.
ChecklistsCheckList, CheckListColumn, CheckListDataRow, CheckListTemplateStructured checklists with columns, rows, and reusable templates.
Contacts & UsersClient, UserInfo, DynamicContact, Division, SkillManage contacts, user profiles, divisions, and skills.
Custom FieldsCustomField, CustomFieldDefinition, CustomFieldPermissionDefine and manage custom fields across entities.
PortfoliosPortfolio, PortfolioTargetPortfolio management and target tracking.
Categories & Master DataCategory, Client, ProjectStatus, TaskStatusCategories, clients, status definitions, and templates.
Calendar & Working TimeCalendar, WorkingTime, WorkingTimeDayOff, ContactNonWorkingTimeWorking time calendars, day-off definitions, and non-working time.
Configuration & PermissionsConfiguration, NotificationFilterSetting, RolePermission, UserPermissionSystem settings, notification preferences, roles, and permissions.
Activity FeedActivity (various functions)Retrieve activity feeds for projects, tasks, documents, and time entries.