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.
New to the API? Head to the Getting Started guide to set up authentication and make your first request in minutes.
Quick Links
Authentication, OData basics, and your first request
💻 Code ExamplesWorking C# examples with Simple.OData.Client
📂 ProjectsCreate, read, update, and manage projects
✅ TasksWork with project tasks and private tasks
⏱️ Time EntriesTrack and query time tracking data
💰 Budget & Line ItemsBudgets, line items, invoicing, and templates
📄 DocumentsManage files, folders, and hyperlinks
📅 PlanningGantt chart planning elements and publications
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/
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.
| Group | Key Endpoints | Description |
|---|---|---|
| Projects | Project, ProjectNote, ProjectStatus, DynamicProject | Create, read, update, and delete projects. Manage members, categories, groups, and favorites. |
| Tasks | Task, TaskItemNote, TaskStatus, DynamicTaskItem | Manage project tasks and private tasks. Assign contributors, track status, and use stopwatch. |
| Time Entries | TimeEntry, TimeEntryComment, DynamicTimeEntry | Record and query time tracking data. Copy entries and add notes. |
| Budget & Line Items | Budget, LineItem, BudgetGroup, BudgetPreset | Financial tracking — budgets, line items, invoicing, and templates. |
| Documents | Document, DocumentFolder, DocumentFolderStructure | File management — upload, link, organize with folders, track favorites. |
| Planning | Planning, PlanningPublication, PlanningTemplate | Gantt chart elements — scheduling, dependencies, snapshots, and backward scheduling. |
| Mind Maps | MindMap, MindMapNode, MindMapTemplate | Create and manage mind maps with nodes. Copy nodes to tasks or timeline. |
| Checklists | CheckList, CheckListColumn, CheckListDataRow, CheckListTemplate | Structured checklists with columns, rows, and reusable templates. |
| Contacts & Users | Client, UserInfo, DynamicContact, Division, Skill | Manage contacts, user profiles, divisions, and skills. |
| Custom Fields | CustomField, CustomFieldDefinition, CustomFieldPermission | Define and manage custom fields across entities. |
| Portfolios | Portfolio, PortfolioTarget | Portfolio management and target tracking. |
| Categories & Master Data | Category, Client, ProjectStatus, TaskStatus | Categories, clients, status definitions, and templates. |
| Calendar & Working Time | Calendar, WorkingTime, WorkingTimeDayOff, ContactNonWorkingTime | Working time calendars, day-off definitions, and non-working time. |
| Configuration & Permissions | Configuration, NotificationFilterSetting, RolePermission, UserPermission | System settings, notification preferences, roles, and permissions. |
| Activity Feed | Activity (various functions) | Retrieve activity feeds for projects, tasks, documents, and time entries. |