Get

[POST] .../v1/projecttask/get

Returns a list of project tasks with filtering and pagination. Use this method to list project tasks visible to the current request user through project ACL, task responsibility, task creation or observer participation. The response returns paged ProjectTask records with chat_id, optional description_mentions, file lists, additional field values, next_offset and total; the request supports filters, selectors, statuses, search, sort_orders, limit and offset. The caller must have project task select permission and missing body, denied access, invalid filters or sort_orders, database failures and persistent errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
include_mentions Boolean Optional Return description_mentions for the task description.
limit Int32 Optional Maximum number of result items. The value is limited by server settings.
offset Int32 Optional Result set offset.
search String Optional Search by the name and description fields.
sort_orders Array of ProjectTaskSortOrder Optional Result sorting.

Filterable Fields

Field Type Description
client_id int
created_user_id int
deal_id int
due_date int
name string
parent_task_id int
project_id int
responsible_user_id int
status int
statuses string Status filter: New, InProgress, Done, Canceled.

Sortable Fields

Field
client_id
closed_date
closed_user_id
created_date
created_user_id
deal_id
due_date
id
last_update
name
project_id
status

Request Example

{
  "project_ids": [
    10
  ],
  "statuses": [
    "New",
    "InProgress"
  ],
  "filters": [
    {
      "Field": "responsible_user_id",
      "Operator": "Equal",
      "Value": 5
    },
    {
      "Field": "due_date",
      "Operator": "GreaterOrEqual",
      "Value": 1772527200
    }
  ],
  "include_mentions": true,
  "sort_orders": [
    {
      "column": "due_date",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of ProjectTask Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 101,
      "project_id": 10,
      "parent_task_id": null,
      "name": "Prepare store opening checklist",
      "description": "Collect all operational tasks before opening day.",
      "description_mentions": [],
      "responsible_user_id": 5,
      "deal_id": null,
      "client": null,
      "chat_id": "9f21dd6c-0b21-4e41-8b6a-36f8d7c47010",
      "observer_user_ids": [
        18
      ],
      "status": "InProgress",
      "due_date": 1772527200,
      "created_date": 1771922400,
      "attachment_file_ids": [
        42
      ],
      "inline_file_ids": [],
      "fields": [],
      "created_user_id": 5,
      "closed_user_id": null,
      "closed_date": null,
      "deleted": false,
      "last_update": 1772010000
    }
  ],
  "next_offset": 0,
  "total": 1
}