Skip to main content

InLoox API Reference

The InLoox API is an OData v4–compatible REST API that provides you with 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

Read the Getting Started guide to set up authentication and send your first request in minutes.

Caution with Write Operations

Most data operations (create, update, delete) cannot be undone. Data may be irretrievably lost.

Deletions may have side effects due to the data structure — for example, removing parent entities also removes their child entities to prevent deletion anomalies.

Therefore, always develop and test on a non-production sandbox account first and back up production data before executing write API operations in your production environment.


Quick Access


Base URLs

Use the appropriate base URL depending on your InLoox deployment:

InLoox Cloud:

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

InLoox Self-Hosted:

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

All endpoint paths in this documentation are relative to the base URL above. For example, odata/Project means https://app.inloox.com/api/odata/Project for Cloud users, or for InLoox Self-Hosted with the server URL https://inloox.mycompany.org it would be https://inloox.mycompany.org/api/v1/odata/Project.


Authentication

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

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

For detailed information on creating 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, 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 the 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 presets.
DocumentsDocument, DocumentFolder, DocumentFolderStructureFile management — upload, link, organize folder structures, 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.
ListsCheckList, CheckListColumn, CheckListDataRow, CheckListTemplateStructured lists with columns, rows, and reusable templates.
PortfoliosPortfolio, PortfolioTargetPortfolio management and target tracking.
Contacts & UsersUserInfo, DynamicContactManage contacts, user profiles, divisions, and skills.
Calendars & Working TimesCalendar, WorkingTime, WorkingTimeDayOff, ContactNonWorkingTimeWorking time calendars, day-off definitions, and non-working times.
Custom FieldsCustomField, CustomFieldDefinition, CustomFieldPermissionDefine and manage custom fields across entities.
Organization & Master DataCategory, Client, Division, ProjectStatus, SkillCategories, clients, status definitions, and templates.
Permissions & Security ConfigurationRolePermission, UserPermission, ValidInviteDomain, ValidLoginDomainRole and user permissions as well as domain settings.