Get All Task Groups

Returns the list of task groups. Return all task group data or retrieve a specific set of task groups using the query parameters.

🚧

Deprecation Notice

This API endpoint is being deprecated in the 24.3 release scheduled for Q4 2024. If you are currently using this API endpoint, please begin efforts to discontinue further usage before release 24.3.

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/taskgroups?start=0&limit=20
  • Page-based pagination is achieved by passing "page" and "size" query parameters. For example: GET /workflow/v1/taskgroups?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/taskgroups?sortBy=+rank,-priority
Language