Get Task Pipeline

Returns workflow tasks assigned to a user or the user's User Group(s). This API returns only tasks that are not completed. By default, tasks are sorted in ascending order based on Priority and then Create Date. Use query parameters to return a specific set of data.

Pagination

Offset-based pagination and Page-based pagination is supported.

Offset-based Pagination is achieved by passing "start" and "limit" query parameters.
For example: GET workflow/v1/taskPipeline?start=0&limit=20

Page-based Pagination is achieved by passing "page" and "size" query parameters.
For example: GET workflow/v1/taskPipeline?page=0&size=20

Sorting

The response data can be sorted by multiple columns. To enable sorting, use the sortBy query parameter to pass a comma-separated list of sortable fields. Each sortable field can be prefixed with '+' or '-' to indicate ascending or descending sorting order.
For example, to order tasks by rank in ascending order and priority in descending order:

GET workflow/v1/taskPipeline?sortBy=+rank,-priority

Query Params
string

Primary assignee of the task template.

string

Assignee Entity ID to return.

string

Assignee Entity Type to return.

string

Association Entity ID to return.

string

Association Entity Type to return.

string

The task pipeline created date from which to start the query. (Date Format MM-DD-YYYY)

string

Created Date (Date Format MM-DD-YYYY)

string

The task pipeline created date from which to end the query. (Date Format MM-DD-YYYY)

string

Due Date (Date Format MM-DD-YYYY)

string

From Due Date (Date Format MM-DD-YYYY)

string

To Due Date (Date Format MM-DD-YYYY)

integer

The maximum number of entities to return as part of the collection.

string

The unique identifier assigned to the loan. Also known as GUID.

boolean

Indicates whether to include metadata.

string

Name of the entity.

integer

Zero-based indicator of the page.

integer

Priority number.

string

Relationship of association.

string

Resolution or disposition of the entity.

integer

The maximum number of entities to return as part of the page.

integer

Zero-based indicator of first collection entity.

string

The task pipeline start date from which the query start from and returning up to current date. (Date Format MM-DD-YYYY)

string

The task pipeline start date from which to start the query. (Date Format MM-DD-YYYY)

string

The task pipeline start date from which to end the query. (Date Format MM-DD-YYYY)

string

A comma-separated list of sortable fields. Each sortable field can be prefixed with '+' or '-' to indicate ascending or descending sorting order.

string

Comma-separated list of status.

string

Comma-separated list of tags.

string

Unique identifier of the task group to return.

string

Partial/ Exact task group name.

string

Comma-separated list of template IDs.

string

Comma-separated list of task types to return.

boolean

Indicates whether to include unassigned tasks.

string

Pipeline view of task service.

string

Work Entity ID to return.

string

Work Entity Type to return.

string

Zone ID.

Headers
string
required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
Response
Choose an example:
application/json