Checklists

The CheckList entity set provides endpoints for managing checklists, their columns, data rows, cell values, and reusable templates. Checklists are tabular data structures attached to projects that can be customized with user-defined columns and populated with rows of values.

---

CheckList

A checklist represents a named, ordered table associated with a project. Each checklist contains columns and data rows.

Properties

Property	Type	Description
CheckListId	guid	Primary key. Unique identifier for the checklist.
ProjectId	guid	Foreign key to the associated project.
OrdinalPosition	int32	Sort order position of the checklist within the project.
Name	string	Display name of the checklist.
InitialColumnNames	string	Comma-separated list of default column names created with the checklist.

Endpoints

List Checklists

GET/odata/CheckList

Returns all checklists. Supports OData query options.

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

Count Checklists

GET/odata/CheckList/$count

Returns the total number of checklists.

Get Checklist

GET/odata/CheckList({key})

Returns a single checklist by its ID.

Parameter	Type	Required	Description
key	guid	✅	The CheckListId of the checklist to retrieve.

Create Checklist

POST/odata/CheckList

Creates a new checklist.

{
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "Requirements Checklist",
  "OrdinalPosition": 0,
  "InitialColumnNames": "Task,Status,Owner"
}

tip

Use InitialColumnNames to pre-populate the checklist with columns on creation. Column names are separated by commas.

Update Checklist

PATCH/odata/CheckList({key})

Partially updates an existing checklist.

Parameter	Type	Required	Description
key	guid	✅	The CheckListId of the checklist to update.

{
  "Name": "Updated Checklist Name",
  "OrdinalPosition": 2
}

Delete Checklist

DELETE/odata/CheckList({key})

Deletes a checklist and all associated columns, rows, and values.

Parameter	Type	Required	Description
key	guid	✅	The CheckListId of the checklist to delete.

warning

Deleting a checklist permanently removes all its columns, rows, and cell values. This action cannot be undone.

Relations

Add Relation

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

Adds a relation to the checklist.

Parameter	Type	Required	Description
key	guid	✅	The CheckListId to add the relation to.

Remove Relation

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

Removes a relation from the checklist.

Parameter	Type	Required	Description
key	guid	✅	The CheckListId to remove the relation from.

---

CheckListColumn

A column defines a field within a checklist. Columns are ordered and typed, controlling what data can be entered in each cell.

Properties

Property	Type	Description
CheckListColumnId	guid	Primary key. Unique identifier for the column.
CheckListId	guid	Foreign key to the parent checklist.
OrdinalPosition	int32	Sort order position of the column within the checklist.
Name	string	Display name of the column.
ColumnType	string	Data type of the column (e.g., text, number, date).

Endpoints

List Columns

GET/odata/CheckListColumn

Returns all checklist columns. Supports OData query options.

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

Count Columns

GET/odata/CheckListColumn/$count

Returns the total number of checklist columns.

Get Column

GET/odata/CheckListColumn({key})

Returns a single column by its ID.

Parameter	Type	Required	Description
key	guid	✅	The CheckListColumnId of the column to retrieve.

Create Column

POST/odata/CheckListColumn

Creates a new column in a checklist.

{
  "CheckListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "Priority",
  "OrdinalPosition": 3,
  "ColumnType": "text"
}

Update Column

PATCH/odata/CheckListColumn({key})

Partially updates an existing column.

Parameter	Type	Required	Description
key	guid	✅	The CheckListColumnId of the column to update.

Delete Column

DELETE/odata/CheckListColumn({key})

Deletes a column from a checklist.

Parameter	Type	Required	Description
key	guid	✅	The CheckListColumnId of the column to delete.

---

CheckListDataRow

A data row represents a single row in a checklist. Rows are ordered and contain cell values defined by the checklist's columns.

Properties

Property	Type	Description
RowId	guid	Primary key. Unique identifier for the row.
CheckListId	guid	Foreign key to the parent checklist.
OrdinalPosition	int32	Sort order position of the row within the checklist.

Endpoints

List Rows

GET/odata/CheckListDataRow

Returns all checklist data rows. Supports OData query options.

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

Count Rows

GET/odata/CheckListDataRow/$count

Returns the total number of checklist data rows.

Get Row

GET/odata/CheckListDataRow({key})

Returns a single row by its ID.

Parameter	Type	Required	Description
key	guid	✅	The RowId of the row to retrieve.

Create Row

POST/odata/CheckListDataRow

Creates a new row in a checklist.

{
  "CheckListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "OrdinalPosition": 0
}

Update Row

PATCH/odata/CheckListDataRow({key})

Partially updates an existing row.

Parameter	Type	Required	Description
key	guid	✅	The RowId of the row to update.

Delete Row

DELETE/odata/CheckListDataRow({key})

Deletes a row from a checklist.

Parameter	Type	Required	Description
key	guid	✅	The RowId of the row to delete.

---

CheckListValue

A value represents the content of a single cell in a checklist, identified by its row and column (field name).

info

CheckListValue exposes only a single POST endpoint. Values are upserted by specifying the target row (RowId) and column (FieldName). If a value already exists for that combination, it is updated; otherwise, a new value is created.

Properties

Property	Type	Description
RowId	guid	Foreign key to the row this value belongs to.
FieldName	string	Column identifier (matches the column name) for this cell.
Value	string	The cell value stored as a string.

Endpoints

Create or Update Value

POST/odata/CheckListValue

Creates or updates a cell value in a checklist row.

{
  "RowId": "a1b2c3d4-5678-9abc-def0-1234567890ab",
  "FieldName": "Status",
  "Value": "Done"
}

---

CheckListTemplate

Templates allow saving a checklist structure (columns and rows) for reuse across projects. Templates can be saved from existing checklists, loaded into projects, and downloaded as files.

Properties

Property	Type	Description
CheckListTemplateId	guid	Primary key. Unique identifier for the template.
Name	string	Display name of the template.

Endpoints

List Templates

GET/odata/CheckListTemplate

Returns all checklist templates. Supports OData query options.

Count Templates

GET/odata/CheckListTemplate/$count

Returns the total number of checklist templates.

Get Template

GET/odata/CheckListTemplate({key})

Returns a single template by its ID.

Parameter	Type	Required	Description
key	guid	✅	The CheckListTemplateId of the template to retrieve.

Create Template

POST/odata/CheckListTemplate

Creates a new checklist template.

{
  "Name": "Sprint Retrospective Template"
}

Update Template

PATCH/odata/CheckListTemplate({key})

Partially updates an existing template.

Parameter	Type	Required	Description
key	guid	✅	The CheckListTemplateId of the template to update.

Delete Template

DELETE/odata/CheckListTemplate({key})

Deletes a checklist template.

Parameter	Type	Required	Description
key	guid	✅	The CheckListTemplateId of the template to delete.

Actions & Functions

Save Template from Checklist

POST/odata/CheckListTemplate/SaveTemplateForCheckList

Saves an existing checklist as a reusable template.

{
  "CheckListId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "TemplateName": "My Checklist Template"
}

Load Template into Project

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

Creates a new checklist in a project from a template.

{
  "TemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ProjectId": "a1b2c3d4-5678-9abc-def0-1234567890ab"
}

Download Template

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

Downloads a template as a file.

Parameter	Type	Required	Description
key	guid	✅	The CheckListTemplate ID.

Download Checklist as Template

GET/odata/CheckListTemplate/DownloadCheckListTemplate(checkListId={checkListId})

Downloads an existing checklist as a template file.

Parameter	Type	Required	Description
checkListId	guid	✅	The ID of the checklist to export as a template file.