Autotask icon

Autotask

Work with Autotask PSA REST API resources

Actions125

Product → List Products

AI-generated

Summary

List matching products with optional filters and pagination.

Inputs

  • returnAll — Whether to return all results or only up to a given Limit.
  • limit — Max number of results to return.
  • includeFields — Optional comma-separated list of fields to include in the response.
  • qfNameContains — Filter to products whose name contains this text.
  • qfProductNumberContains — Filter to products whose SKU / product number contains this text.
  • qfProductCategory — Filter to products in the specified product category.
  • qfIsActive — Filter to products whose isActive flag matches this value (Any = no filter).
  • useAdvancedFilters — Whether to show advanced filter controls (row-builder + raw JSON).
  • advancedFilters — Add filter clauses by field name and operator; joined with AND.
  • filterJson — Raw Autotask filter array for OR groups, nested clauses, or any filter the UI cannot express.
  • requestOptions — Header overrides or impersonation resource ID for the request.

Output shape

a list of product records (possibly paginated)

Pagination is controlled by limit; returnAll expands results; includeFields can limit returned fields; error envelope not part of normal output.

Examples

Example 1: Retrieve up to 100 active products.

returnAll=false, limit=100, qfIsActive=true

Example 2: Search products by name substring and return only id and name.

qfNameContains=widget, includeFields=id,name

Example 3: Filter products by category and active status using advanced filters.

qfProductCategory=cat123, qfIsActive=true, useAdvancedFilters=true

Links

Discussion