academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Task-types [Beta] → Find task-types

AI-generated

Summary

Retrieve a list of task-types from the academyFIVE API with support for pagination, filtering by IDs, and sorting.

Inputs

  • Additional Fields — Optional query parameters including page number (default 1), page size (default 50), filter by specific task-type IDs, and sort order (comma separated fields with optional descending prefix).

Output shape

a list of JSON objects representing task-types matching the query parameters

Supports pagination via page[number] and page[size] query parameters. Filtering by IDs via filter[ids] is supported, as well as sorting with the sort parameter. Returns JSON formatted data by default.

Examples

Example 1: Get the first page of task-types with default page size

Leave Additional Fields empty or unset to retrieve the first 50 task-types.

Example 2: Filter task-types by specific IDs

Set filter[ids] in Additional Fields to a comma-separated list of IDs to retrieve only those task-types.

Example 3: Retrieve a custom page of results sorted descending by a field

Set page[number] to the desired page, page[size] to the desired number of results per page, and sort to a field prefixed by '-' to sort descending.

Links

Discussion