GET /task

Search Tasks

GET

/task

Search tasks using multi-dimensional filter parameters.

Executes Queries.FIND_TASKS with the bound TaskSearchParameters. Supports
filtering by status flags, date ranges, assignees, and linked entities
(issue, work order, product, serial). advanced_filters accepts a
base64-encoded JSON object. Default limit is 200 rows.

Emits: (direct transaction — no event class)

Required scope: collaboration:task:read

Authorizations

OAuth2PasswordBearer

password Flow

Token URL"/api/auth"

Scopes:

• "admin"User can access and edit users and system settings
• "library"User can access and edit products
• "production"User can access and edit production plans
• "operator"User can access the operator panel and make production declarations

Parameters

Query Parameters

search

Free-text search string matched against task title and description.

Example"rework"

task_type_key

Filter to tasks belonging to a specific task type.

Example"tasktype_001"

status_pending

Include tasks with status pending when true.

Exampletrue

status_open

Include tasks with status open when true.

Exampletrue

status_completed

Include tasks with status completed when true.

Examplefalse

status_canceled

Include tasks with status canceled when true.

Examplefalse

owner_key

Filter to tasks owned by a specific user.

Example"user42"

assigned_to

Filter to tasks assigned to any of the listed user keys.

Example"user42""user99"

start_from_min

Lower bound for the start_from date filter (inclusive).

Example"2026-05-01"

start_from_max

Upper bound for the start_from date filter (inclusive).

Example"2026-05-31"

due_by_min

Lower bound for the due_by date filter (inclusive).

Example"2026-05-01"

due_by_max

Upper bound for the due_by date filter (inclusive).

Example"2026-05-31"

created_min

Lower bound for the created date filter (inclusive).

Example"2026-05-01"

created_max

Upper bound for the created date filter (inclusive).

Example"2026-05-31"

closed_min

Lower bound for the closed date filter (inclusive).

Example"2026-05-01"

closed_max

Upper bound for the closed date filter (inclusive).

Example"2026-05-31"

advanced_filters

Additional filter criteria as a JSON object (or base64-encoded JSON string, decoded by validator).

issue_key

Filter to tasks linked to a specific issue.

Example"issue_001"

work_order_key

Filter to tasks linked to a specific work order.

Example"wo_2026_001"

product_key

Filter to tasks linked to a specific product.

Example"prod_abc"

serial_key

Filter to tasks linked to a specific serial number record.

Example"serial_xyz"

linked_task_key

Filter to tasks linked to another specific task.

Example"task_001"

limit

Maximum number of results to return. Defaults to 200.

Example200

Default

200

offset

Number of results to skip for pagination.

Example0

Default

0

Responses

Successful Response

Content-Type

application/json

[

  

{

  

  

"_id": "string",

  

  

"_key": "string",

  

  

"_rev": "string",

  

  

"task_type_key": "tasktype_001",

  

  

"code": "TASK-2026-001",

  

  

"status": "open",

  

  

"owner_key": "user42",

  

  

"assigned_to": [

  

  

  

{

  

  

  

  

"user_key": "user42",

  

  

  

  

"role": "participant"

  

  

  

}

  

  

],

  

  

"start_from": "2026-05-05T08:00:00Z",

  

  

"due_by": "2026-05-10T17:00:00Z",

  

  

"created": "2026-05-04T09:00:00Z",

  

  

"created_by": "user42",

  

  

"closed": "2026-05-08T14:00:00Z",

  

  

"closed_by": "user42",

  

  

"title": "Verify dimensional tolerance after rework",

  

  

"description": "Check all 6 key dimensions against drawing rev. B. All must be within ±0.1 mm.",

  

  

"form_fields": [

  

  

  

{

  

  

  

  

"form_field_key": "ffd-001",

  

  

  

  

"custom_field_key": "cf-001",

  

  

  

  

"label": "Surface Colour",

  

  

  

  

"hint": "Verify against approved colour chart",

  

  

  

  

"mandatory": false,

  

  

  

  

"value": null,

  

  

  

  

"last_updated": "2026-03-22T14:30:00Z"

  

  

  

}

  

  

],

  

  

"icon": "check_circle",

  

  

"task_type_name": "Quality Inspection"

  

}

]

Samples

Powered by VitePress OpenAPI