Ayudala icon

Ayudala

Interact with the Ayudala helpdesk & service management platform

Actions82

Knowledge Base Category → Get Many

AI-generated

Summary

Fetch Knowledge Base Category records, optionally limiting the count and including extra fields.

Inputs

  • returnAll (required) — Whether to return all results or only up to a given limit.
  • limit (required) — Maximum number of results to return (1‑100). Ignored when returnAll is true.
  • additionalFields — Optional fields to include in the response such as tree structure, inactive status, and visibility filter.

Output shape

array of Knowledge Base Category objects (each representing a category record).

If returnAll is false and limit is omitted, the default limit is 50. The response may include nested tree structure, inactive categories, and visibility filter based on additionalFields. Pagination is handled by the API but not exposed in the response shape.

Examples

Example 1: Retrieve up to 10 public categories in tree form

returnAll=false, limit=10, additionalFields={tree:true, visibility:'public'}

Example 2: Get all active categories with internal visibility

returnAll=true, additionalFields={include_inactive:false, visibility:'internal'}

Example 3: Fetch the first 50 categories without any extra fields

returnAll=false, limit=50, additionalFields={}

Links

Discussion