# API to get Tasks based on query parameters

**GET /tasks**

This API will be used for fetching the tasks based on the filter parameters as mentioned below.
Defined parameters values will be considered as filter criteria and all parameters are non manadatory.



## Servers
- https://usaapi02.cadencyservices.trintech.com/test/api: https://usaapi02.cadencyservices.trintech.com/test/api ()


## Authentication methods
- Oauth2


## Parameters


### Query parameters
- **page** (integer(int32))
  The `page` define the current page number. It should be positive integer number and should start with minimum value 1.
- **size** (integer(int32))
  The `size` define number of records on each page. It should be positive integer number between 1 to 10000.
- **sort** (array[string])
  The `sort` parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.
- **name** (string)
  The `name` parameter is an optional filter that allows you to narrow down the results based on specific name content.
- **entityId** (string)
  Filter Tasks based on the entityId.
- **periodId** (string)
  Filter Tasks based on the periodId. Period Id can be found using the api under period section which helps us to find the active periods.
- **priority** (string)
  Filter Tasks based on the priority. If not provided, considered all priority tasks.
  You can pass the values from ENUM: `High`, `Medium`, `Low` and `Unspecified`.
- **critical** (string)
  If `critical set as `true`, only critical tasks will be returned. If `false`, all tasks will be considered.
- **taskTypeId** (string)
  Filter Tasks based on the `TaskTypeId`. If not provided, considered all task types.
  You can fetch all ACTIVE Task Types using the api `task-types` under `System Values` section.
- **taskId** (string)
  Filter Tasks based on the taskId.
- **status** (string)
  Filter Tasks based on the status based on the enum defined.
- **inboxId** (string)
  Filter Tasks based on the inboxId.
- **inboxUserIds** (string)
  Filter Tasks based on a set of inboxId.
- **inboxType** (string)
  Filter Tasks based on the inboxType. Inbox Types can be `U` stands for User and `Q` stands for Queue.
- **actionPlanIds** (string)
  Filter Tasks based on the actionPlanIds. We can pass mutiple actionIds.
- **dashboardRequest** (string)
  Filter Tasks based on the dashboardRequest. dashboardRequest is by default false.
- **isAssignedOnly** (string)
  If set to `true` will return all assigned Tasks and If not, consider all the tasks which is assigned and not assigned.
- **dashboardIdList** (string)
  Filter Tasks based on the dashboardIdList. Multiple dashboardIds are allowed.
- **descendantIds** (string)
  Filter Tasks based on the descendantIds. Multiple descendantIds are allowed.
- **viewableTDIds** (string)
  Filter Tasks based on the viewableTDIds. Multiple viewableTDIds are allowed.
- **include** (string)
  Add include as `CHILDREN` for fetch tasks including the children details.


## Responses
### 200
OK

#### Body: application/json (object)
- **result** (array[object])

- **metadata** (object)
  Paging metadata dto.


[Powered by Bump.sh](https://bump.sh)