Lists

Lists in InLoox enable structured collection of tabular data within a project. Each list consists of columns (field definitions), data rows, and associated values. Templates allow reuse of list structures.

info

Lists are always associated with a project. Use ProjectId when filtering to retrieve only the lists of a specific project.

CheckList

The CheckList entity represents a single list within a project.

Data Model

Property	Type	Description
`CheckListId`	`guid`	Unique ID of the list.
`ProjectId`	`guid`	ID of the associated project.
`OrdinalPosition`	`int32`	Sort position of the list within the project.
`Name`	`string`	Name of the list.
`InitialColumnNames`	`string[]`	Initial column names when creating (optional).

Endpoints

Retrieve all lists across all projects

GET/odata/CheckList

Supports OData query options.

Retrieve a list by ID

GET/odata/CheckList({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListId.

Create a new list

POST/odata/CheckList

tip

Use InitialColumnNames to create columns directly when creating the list. Otherwise, you can add columns later via the CheckListColumn endpoint.

Update an existing list

PATCH/odata/CheckList({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListId.
`Body`	`Delta<ApiCheckList>`	✅	JSON object with the fields to update.

Delete a list

DELETE/odata/CheckList({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListId.

warning

Deleting a list also removes all associated columns, rows, and values. This action cannot be undone.

Returns 204 No Content on success.

Relations

Add a relation to the list

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

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListId.
`itemId`	`guid`	✅	The ID of the item to link.

Remove a relation from the list

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

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListId.
`itemId`	`guid`	✅	The ID of the relation to remove.

CheckListColumn

The CheckListColumn entity defines the columns (fields) of a list.

Data Model

Property	Type	Description
`CheckListColumnId`	`guid`	Unique ID of the column.
`CheckListId`	`guid`	ID of the associated list.
`OrdinalPosition`	`int32`	Sort position of the column.
`Name`	`string`	Column name.
`ColumnType`	`int32`	Column type: 0 = Text, 1 = Date/Time, 2 = Integer, 3 = Decimal, 4 = Boolean, 5 = Dropdown list, 6 = Currency.

Endpoints

Retrieve all list columns across all lists in all projects

GET/odata/CheckListColumn

Supports OData query options.

Retrieve a column by ID

GET/odata/CheckListColumn({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListColumnId.

Create a new column

POST/odata/CheckListColumn

Parameter	Type	Required	Description
`Body`	`Delta<ApiCheckListColumn>`	✅	JSON object with the column properties.

Update a column

PATCH/odata/CheckListColumn({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListColumnId.
`Body`	`Delta<ApiCheckListColumn>`	✅	JSON object with the fields to update.

Delete a column

DELETE/odata/CheckListColumn({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListColumnId.

warning

Deleting a column also removes all associated cell values. This action cannot be undone.

Returns 204 No Content on success.

CheckListDataRow

The CheckListDataRow entity represents a data row in a list. The actual values are stored via CheckListValue.

Data Model

Property	Type	Description
`RowId`	`guid`	Unique ID of the row.
`CheckListId`	`guid`	ID of the associated list.
`OrdinalPosition`	`int32`	Sort position of the row.

Endpoints

Retrieve all data rows. Supports OData query options

GET/odata/CheckListDataRow

Retrieve a data row by ID

GET/odata/CheckListDataRow({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The RowId.

Create a new data row

POST/odata/CheckListDataRow

Update a data row

PATCH/odata/CheckListDataRow({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The RowId.
`Body`	`Delta<ApiCheckListDataRow>`	✅	JSON object with the fields to update.

Delete a data row

DELETE/odata/CheckListDataRow({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The RowId.

warning

Deleting a row also removes all associated cell values. This action cannot be undone.

Returns 204 No Content on success.

CheckListTemplate

The CheckListTemplate entity enables saving and loading list templates. Templates can be created from existing lists and loaded into other projects.

Data Model

Property	Type	Description
`CheckListTemplateId`	`guid`	Unique ID of the template.
`Name`	`string`	Name of the template.

Endpoints

CRUD Operations

Retrieve all list templates

GET/odata/CheckListTemplate

Supports OData query options.

Retrieve a template by ID

GET/odata/CheckListTemplate({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListTemplateId.

Create a new template

POST/odata/CheckListTemplate

Update a template

PATCH/odata/CheckListTemplate({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListTemplateId.
`Body`	`Delta<ApiCheckListTemplate>`	✅	JSON object with the fields to update.

Delete a template

DELETE/odata/CheckListTemplate({key})

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListTemplateId.

warning

Deleting a template cannot be undone.

Returns 204 No Content on success.

Template Management

Save a template from an existing list

POST/odata/CheckListTemplate/SaveTemplateForCheckList

Parameter	Type	Required	Description
`Body`	`object`	✅	JSON object with the following fields: checkListId (guid, required) — The CheckListId of the list to save as a template. name (string, required) — Name of the new template.

Saves the structure of an existing list as a reusable template.

Load a template into a project

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

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListTemplateId of the template to load.
`Body`	`object`	✅	JSON object with the following fields: projectId (guid, required) — The ID of the project to load the template into.

Creates a new list in the specified project based on the template.

Prerequisite

Loading a template requires the target project's folder structure to be initialized. If the document store cannot be created automatically, the request fails — initialize the folder structure in the project's Documents tab, then retry.

Download a template

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

Parameter	Type	Required	Description
`key`	`guid`	✅	The CheckListTemplateId.

Returns a file with content type application/xml and file name {TemplateName}.json.

CheckListValue

The CheckListValue entity stores the value of a single cell (row × column) in a list.

Data Model

Property	Type	Description
`RowId`	`guid`	ID of the associated data row.
`FieldName`	`guid`	ID of the column (CheckListColumnId).
`Value`	`any`	The stored value (type varies depending on the column type).

Endpoints

Create or update a cell value

POST/odata/CheckListValue

Creates or updates the value of a single cell in a list.

info

The Value type must match the column type (ColumnType). For checkbox columns, use true/false; for number columns, use a numeric value.

OData Query Examples

Retrieve lists of a project

GET /odata/CheckList?$filter=ProjectId eq {projectId}&$orderby=OrdinalPosition asc

Create a list

POST /odata/CheckList
Content-Type: application/json

{
  "ProjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Name": "Quality Check",
  "OrdinalPosition": 0,
  "InitialColumnNames": "Task,Status,Responsible"
}

Update a list

PATCH /odata/CheckList('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
Content-Type: application/json

{
  "Name": "Quality Check – Version 2",
  "OrdinalPosition": 2
}

Retrieve columns of a list

GET /odata/CheckListColumn?$filter=CheckListId eq {checkListId}&$orderby=OrdinalPosition asc

Create a column

POST /odata/CheckListColumn
Content-Type: application/json

{
  "CheckListId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Name": "Responsible",
  "OrdinalPosition": 3,
  "ColumnType": "text"
}

Retrieve rows of a list

GET /odata/CheckListDataRow?$filter=CheckListId eq {checkListId}&$orderby=OrdinalPosition asc

Create a row

POST /odata/CheckListDataRow
Content-Type: application/json

{
  "CheckListId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "OrdinalPosition": 0
}

Set a cell value

POST /odata/CheckListValue
Content-Type: application/json

{
  "RowId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "FieldName": "Status",
  "Value": "Passed"
}

Create a template

POST /odata/CheckListTemplate
Content-Type: application/json

{
  "Name": "Standard Quality Check"
}

Save a list as a template

POST /odata/CheckListTemplate/SaveTemplateForCheckList
Content-Type: application/json

{
  "CheckListId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "TemplateName": "Template from Quality Check"
}

Load a template into a project

POST /odata/CheckListTemplate('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/LoadTemplateForProject
Content-Type: application/json

{
  "TemplateId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "ProjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

tip

Combine $filter with $orderby to retrieve lists, columns, and rows in the correct display order. Filtering by ProjectId or CheckListId is the most common pattern.

CheckList​

Data Model​

Endpoints​

Relations​

CheckListColumn​

Data Model​

Endpoints​

CheckListDataRow​

Data Model​

Endpoints​

CheckListTemplate​

Data Model​

Endpoints​

CRUD Operations​

Template Management​

CheckListValue​

Data Model​

Endpoints​

OData Query Examples​

Retrieve lists of a project​

Create a list​

Update a list​

Retrieve columns of a list​

Create a column​

Retrieve rows of a list​

Create a row​

Set a cell value​

Create a template​

Save a list as a template​

Load a template into a project​

CheckList

Data Model

Endpoints

Relations

CheckListColumn

Data Model

Endpoints

CheckListDataRow

Data Model

Endpoints

CheckListTemplate

Data Model

Endpoints

CRUD Operations

Template Management

CheckListValue

Data Model

Endpoints

OData Query Examples

Retrieve lists of a project

Create a list

Update a list

Retrieve columns of a list

Create a column

Retrieve rows of a list

Create a row

Set a cell value

Create a template

Save a list as a template

Load a template into a project