Get All Templates

Returns the list of task templates. Return all task template data or a specific set of task templates using the query parameters.

Usage Notes

  • The taskTypeName attribute is stored in the metadata object. To retrieve the taskTypeName (if exists), pass the query parameter metaData=true.

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/tasks/items?start=0&limit=20
  • Page-based pagination is achieved by passing "page" and "size" query parameters. For example: GET workflow/v1/tasks/items?page=0&size=20
Query Params
string

The unique identifier assigned to the task group template to return.

string

Association Entity ID to return.

string

Association Entity Type to return.

boolean

Specify True to indicate the AutoCreate flag is set. The default is False.

string

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

string

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

string

The user who last modified the task template.

integer

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

boolean

Indicates whether to include metadata.

string

The task template name.

string

Zero-based indicator of the page.

boolean

Specify True to indicate partial properties to be returned in the query. The default is False.

string

Comma-separated list of partial properties to be returned. Only applicable if partial is set to True.

integer

Priority number of the task template.

string

Relationship of association.

integer

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

boolean

Indicates whether the persona should be skipped.

string

Comma-separated list of properties names in which to sort.

integer

Zero-based indicator of first collection entity.

string

Comma-separated list of tags

string

The task group template name.

string

Comma-separated list of task group template IDs.

string

Comma-separated list of template IDs.

string

Lender-defined ID labeled as template ID in the user interface.

string

Comma-separated list of types.

Headers
string
required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

User Not Found

500

Internal Server Error

Language
URL
Response
Choose an example:
application/json