Get

[POST] .../v1/project/get

Returns a list of projects according to the user access rights. Use this method to list active projects visible to the current request user, including projects granted through project ACL and projects that contain tasks where the user participates. The response returns paged Project records with access_user_ids, access_group_ids, next_offset and total; the request supports filters id, responsible_user_id, name and description, while ids, responsible_user_ids and search fields. The caller must have project select permission or, when only task select is available, task-level visibility is used; missing body, denied access, storage 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.
limit Int32 Optional Maximum number of result items.
offset Int32 Optional Result set offset.
search String Optional Search by the name and description fields.
sort_orders Array of BaseSortColumn Optional Sort parameters. Supported columns are id, name, responsible_user_id and last_update.

Filterable Fields

Field Type Description
description string
id int Project ID array.
name string
responsible_user_id int Responsible user filter.

Request Example

{
  "filters": [
    {
      "Field": "responsible_user_id",
      "Operator": "Equal",
      "Value": "5"
    },
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "store launch"
    }
  ],
  "sort_orders": [
    {
      "column": "name",
      "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 Project Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 10,
      "name": "New store launch",
      "description": "Tasks for opening the next retail store.",
      "logo_file_id": 42,
      "responsible_user_id": 5,
      "access_all": false,
      "access_user_ids": [
        5,
        18
      ],
      "access_group_ids": [
        3
      ],
      "deleted": false,
      "created_user_id": 5,
      "created_date": 1772527200,
      "last_update": 1772527200
    }
  ],
  "next_offset": 0,
  "total": 1
}