Query Statuses
Retrieve a list of all statuses within the organization
/statuses
Response
Sample response →
[
...
{
"id": "STATUS-ID",
"color": 5,
"description": "Sample status description",
"name": "In progress",
"systemStatus": 2
}
...
]
Query Task Types
Retrieve a list of available task types
/task-types
Response
Sample response →
[
...
{
"id": "TASK-TYPE-ID",
"icon": "task",
"name": "Task",
"settings": {
"actionRequired": "denied_on_reply",
"isGeneric": false,
"requiredFields": []
},
"sortPosition": 4
}
...
]
Todo lists format
Todo lists can be attached to various item types including tasks, reminders, meetings and others.
When updating, you have to update the entire todo list rather then individual items.
Todo list format:
[
{
"uid": "TODO-LIST-UNIQ-GENERATED-ID",
"title": "ToDo List title",
"createdByUserId": "USER-ID",
"momentCreated": "UTC DATE-TIME in ISO 8601 format",
"items": [
{
"properties": {
"completed": false,
"title": "Todo item 1",
"userId": "ASSIGNED-USER-ID"
}
}
]
}
]
Plese note that you can have multiple todo lists attached to an item. Here is an example with 2 todo lists:
[
{
"uid": "1",
"title": "ToDo List 1",
"createdByUserId": "USER-ID",
"momentCreated": "2022-01-01T10:00:00.000Z",
"items": [
{
"properties": {
"completed": false,
"title": "Todo item 1",
"userId": "USER-ID"
}
},
{
"properties": {
"completed": true,
"title": "Todo item 2",
"userId": null
}
}
]
},
{
"uid": "2",
"title": "ToDo List 2",
"createdByUserId": "USER-ID",
"momentCreated": "2022-01-01T10:00:00.000Z",
"items": [
{
"properties": {
"completed": false,
"title": "Todo item 3",
"userId": null
}
}
]
}
]
Offices
Get list of company offices
/offices
Response
Sample response →
[
{
"companyId": "COMPANY_ID",
"description": "Some description",
"id": "OFFICE_ID",
"ipAddresses": ["192.168.1.10"],
"isDeleted": false,
"name": "Main Office",
"sortPosition": 0
},
...
]
