TODOs
A TODO is a task with assignees, due dates and a simple history. The API lets you create, update and progress tasks. See TODO Management for the full workflow.
Methods
Section titled “Methods”Retrieve Single TODO
Section titled “Retrieve Single TODO”/backend/api/v1/todos/ID - fetch the TODO with the specified ID.
List TODOs
Section titled “List TODOs”/backend/api/v1/todos/ - list all TODOs.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include TODOs with a higher ID |
createdSince | datetime | No | Only include TODOs created since the given time |
updatedSince | datetime | No | Only include TODOs updated since the given time |
/backend/api/v1/todos/ - create a new TODO. The newly-added TODO will be returned.
/backend/api/v1/todos/ID - update the TODO with the specified ID. The modified TODO will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/todos/ID - delete the TODO with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| subject | Subject | Text | Short summary of the TODO |
| content | Details | Text (Multiline) | |
| users | Users | Preset Value(s) | Additional users involved |
| departments | Departments | Preset Value(s) | |
| status | Status | Preset Value | |
| todoType | Type | Preset Value | |
| nextStep | Next Step | Preset Value | |
| dueDate | Due Date | Date | |
| notBeforeDate | Snoozed Until | Date | |
| expiryDate | Expiry Date | Date | |
| repeatRule | Repeat Rule | Preset Value | |
| repeatUntilDate | Repeat Until | Date | |
| completedDate | Completed Date | Date | |
| reviewRequired | Review Required | Preset Value | |
| reviewUsers | Reviewers (Users) | Preset Value(s) | |
| reviewDepartments | Reviewers (Departments) | Preset Value(s) | |
| createdDate | Created | Date | |
| lastUpdatedDate | Last Updated | Date | |
| lastUpdatedUser | Last Updated By | Preset Value | |
| autoRule | Auto Rule | Preset Value | If set, shows which Auto Rule created this TODO. |
| id | TODO ID | Text | |
| attached | Attached to | HTML |