Zorus icon

Zorus

Interact with the Zorus API to manage customers, endpoints, groups, policies, deployment tokens, and unblock requests

Actions13

Groups → Post Api Groups Search

AI-generated

Summary

Send a POST request to search for groups using various filters, pagination, and sorting options against the Zorus API.

Inputs

  • Zorus Api Version (required) — Specify the API version to send in the 'Zorus-Api-Version' header (default is '1.0').
  • Additional Body Fields — Optional filters and settings for the group search: includes pagination (page, pageSize), sorting (sortProperty, sortAscending), and multiple optional filters such as nameContains, uuidEquals, policyUuidEquals, customerUuidEquals, customerNameContains, syncOptionsToMembers, syncAddonsToMembers.

Output shape

a list of group objects

The operation returns an array of groups matching the provided criteria. Each group object includes properties like name, uuid, policyUuid, customerName, customerUuid, syncOptionsToMembers, and syncAddonsToMembers. The result supports pagination through 'page' and 'pageSize' inputs.

Examples

Example 1: Search for groups whose name contains 'Sales', sorted by Name ascending with 10 items per page.

Set 'nameContains' to 'Sales', 'sortProperty' to 'Name', 'sortAscending' true, 'pageSize' to 10, and optionally set 'page' for pagination.

Links

Discussion