Tasks

The Task entity represents work items within a project. Tasks can be organized on Kanban boards or in list views, assigned to contacts, tracked with stopwatches, and linked to documents and other entities.

info

To access custom fields on tasks, query the DynamicTaskItem endpoint. It returns all standard properties plus any user-defined fields.

---

Data Model

Property	Type	Description
TaskItemId	guid	Unique identifier of the task.
Name	string	Display name / title of the task.
TaskItemStatusId	guid?	ID of the task status (e.g., Open, In Progress, Done).
ContactId	guid?	ID of the contact the task is assigned to.
ProjectId	guid?	ID of the project this task belongs to.
PlanningId	guid?	ID of the linked planning element (work package).
GroupId	guid?	ID of the task group (Kanban column / category).
StartDateTime	datetime?	Scheduled start date and time.
EndDateTime	datetime?	Scheduled end date and time.
IsDone	bool	Whether the task is marked as completed.
DoneDate	datetime?	Date and time when the task was completed.
WorkAmount	double?	Total effort estimate in hours.
CustomColor	string	Hex color code for visual highlighting (e.g., '#FF5733').
CardPositionNumber	int?	Sort order position within a Kanban column.
RiskName	string	Name of the associated risk.
RiskId	guid?	ID of the associated risk entity.
AssignedByContactId	guid?	ID of the contact who assigned this task.
CreatedByContactId	guid?	ID of the contact who created this task.
ContactDisplayName	string	Display name of the assigned contact (read-only).
ContactImageId	guid?	Image ID of the assigned contact (read-only).
DescriptionHTML	string	HTML-formatted task description.
Recurrence	string	Recurrence rule string (iCal RRULE format) if the task repeats.
IsBillable	bool	Whether work on this task is billable.
ChecklistItemsCount	int	Total number of checklist items (read-only).
CheckListItemsDoneCount	int	Number of completed checklist items (read-only).
CheckListItemsOpenCount	int	Number of open checklist items (read-only).
ContributorsCount	int	Number of contributors assigned to this task (read-only).
ContributorsWorkAmount	double?	Combined effort of all contributors in hours (read-only).
WorkAmountOwner	double?	Effort assigned to the primary owner in hours.

---

Endpoints

CRUD Operations

GET/odata/Task

List all tasks

Returns all tasks the authenticated user has access to. Supports OData query options.

---

GET/odata/Task({key})

Get a single task by ID

Parameter	Type	Required	Description
key	guid	✅	The unique task ID.

---

POST/odata/Task

Create a new task

{
  "Name": "Design mockups",
  "ProjectId": "project-guid",
  "ContactId": "assignee-contact-guid",
  "StartDateTime": "2025-04-01T09:00:00Z",
  "EndDateTime": "2025-04-05T17:00:00Z",
  "IsBillable": true
}

---

PATCH/odata/Task({key})

Update an existing task

Parameter	Type	Required	Description
key	guid	✅	The task ID to update.

Send only the properties you want to change:

{
  "IsDone": true,
  "DoneDate": "2025-04-04T16:30:00Z"
}

---

DELETE/odata/Task({key})

Delete a task

Parameter	Type	Required	Description
key	guid	✅	The task ID to delete.

---

GET/odata/Task/$count

Get total number of tasks

Returns the count as a plain integer. Supports $filter.

---

Batch Operations

POST/odata/Task/BatchInsert

Create multiple tasks in a single request

{
  "Tasks": [
    { "Name": "Task A", "ProjectId": "project-guid" },
    { "Name": "Task B", "ProjectId": "project-guid" }
  ]
}

tip

Use batch operations to reduce round-trips when creating or deleting many tasks at once.

---

POST/odata/Task/BatchDelete

Delete multiple tasks in a single request

{
  "TaskItemIds": ["task-id-1", "task-id-2", "task-id-3"]
}

warning

Batch delete permanently removes all specified tasks. This action cannot be undone.

---

Task Management

POST/odata/Task({key})/MoveTaskItem

Move a task to a different group or position

Parameter	Type	Required	Description
key	guid	✅	The task ID to move.

{
  "GroupId": "target-group-guid",
  "CardPositionNumber": 2
}

---

POST/odata/Task({key})/UpdateProjectDefinedField

Update a project-defined field on the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

POST/odata/Task({key})/Copy

Create a copy of the task

Parameter	Type	Required	Description
key	guid	✅	The source task ID to copy.

Returns the newly created task.

---

Notes

POST/odata/Task({key})/AddNote

Add a note to the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "Text": "Waiting for design approval before proceeding."
}

---

GET/odata/Task/DeleteNote(noteRelationId={noteRelationId})

Delete a note from a task

Parameter	Type	Required	Description
noteRelationId	guid	✅	The note relation ID to delete.

---

Contributors

Contributors are additional contacts assigned to work on a task alongside the primary owner.

GET/odata/Task({key})/GetContributors()

Get all contributors for a task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

POST/odata/Task({key})/AddContributor

Add a contributor to the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "ContactId": "contributor-contact-guid",
  "WorkAmount": 8.0
}

---

POST/odata/Task({key})/UpdateContributor

Update a contributor's details

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "ContactId": "contributor-contact-guid",
  "WorkAmount": 12.0
}

---

POST/odata/Task({key})/RemoveContributor

Remove a contributor from the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "ContactId": "contributor-contact-guid"
}

---

Stopwatch

The stopwatch feature allows time tracking directly from a task.

GET/odata/Task({key})/GetStopwatch()

Get the current stopwatch state

Parameter	Type	Required	Description
key	guid	✅	The task ID.

Returns the current stopwatch status, elapsed time, and state (running, paused, stopped).

---

POST/odata/Task({key})/StartStopwatch

Start the stopwatch

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

POST/odata/Task({key})/PauseStopwatch

Pause the stopwatch

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

POST/odata/Task({key})/StopStopwatch

Stop the stopwatch and create a time entry

Parameter	Type	Required	Description
key	guid	✅	The task ID.

info

Stopping the stopwatch automatically creates a time entry with the recorded duration.

---

Documents

POST/odata/Task({key})/AddDocumentToTaskItem

Link a document to the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "DocumentId": "document-guid"
}

---

POST/odata/Task({key})/RemoveDocumentFromTaskItem

Remove a document link from the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "DocumentId": "document-guid"
}

---

Relations

POST/odata/Task({key})/AddRelation

Add a relation to another entity

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "TargetId": "target-entity-guid",
  "RelationType": "RelatedTo"
}

---

POST/odata/Task({key})/RemoveRelation

Remove an existing relation

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "RelationId": "relation-guid"
}

---

Calendar Sync

Synchronize tasks with external calendar systems.

GET/odata/Task({key})/GetCalendarSyncStatus()

Get the calendar sync status

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

POST/odata/Task({key})/EnableCalendarSync

Enable calendar synchronization for the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

POST/odata/Task({key})/DisableCalendarSync

Disable calendar synchronization for the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

Notification Followers

POST/odata/Task({key})/AddNotificationFollowers

Add notification followers to the task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "ContactIds": ["contact-id-1", "contact-id-2"]
}

---

POST/odata/Task({key})/RemoveNotificationFollower

Remove a notification follower

Parameter	Type	Required	Description
key	guid	✅	The task ID.

{
  "ContactId": "contact-guid"
}

---

GET/odata/Task({key})/GetNotificationFollowerContacts()

Get all notification followers for a task

Parameter	Type	Required	Description
key	guid	✅	The task ID.

---

Custom Fields — DynamicTaskItem

Use the DynamicTaskItem endpoint to access tasks with custom fields:

GET /odata/DynamicTaskItem
GET /odata/DynamicTaskItem({key})

Custom field names follow the pattern CF_<FieldName>.

warning

DynamicTaskItem only supports GET requests. To create or update tasks, use the regular /odata/Task endpoints.

---

OData Query Examples

Filter Tasks by Project

curl -X GET "https://{tenant}.inloox.app/odata/Task?\
$filter=ProjectId eq {project-guid}\
&$select=TaskItemId,Name,IsDone,ContactDisplayName\
&$orderby=CardPositionNumber asc" \
  -H "Authorization: Bearer {token}"

Open Tasks Assigned to a Specific Contact

curl -X GET "https://{tenant}.inloox.app/odata/Task?\
$filter=ContactId eq {contact-guid} and IsDone eq false\
&$orderby=EndDateTime asc" \
  -H "Authorization: Bearer {token}"

Paging

curl -X GET "https://{tenant}.inloox.app/odata/Task?\
$top=25&$skip=0&$orderby=Name asc" \
  -H "Authorization: Bearer {token}"

C# Example

using System.Net.Http;
using System.Net.Http.Headers;

var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

// Get open tasks for a project
var response = await client.GetAsync(
    "https://{tenant}.inloox.app/odata/Task?" +
    $"$filter=ProjectId eq {projectId} and IsDone eq false" +
    "&$select=TaskItemId,Name,ContactDisplayName,EndDateTime" +
    "&$orderby=EndDateTime asc");

var json = await response.Content.ReadAsStringAsync();
Console.WriteLine(json);

// Create a task
var payload = new StringContent(
    """
    {
      "Name": "Review documentation",
      "ProjectId": "{project-guid}",
      "ContactId": "{contact-guid}",
      "IsBillable": true
    }
    """,
    System.Text.Encoding.UTF8,
    "application/json");

var createResponse = await client.PostAsync(
    "https://{tenant}.inloox.app/odata/Task", payload);

tip

Combine $filter with $select to minimize payload size. For tasks, filtering by ProjectId and IsDone is the most common pattern.