Skip to main content

Find Grouptypes

POST 
/groups-srv/graph/grouptypes

This API call finds user group types using a graph filter to select the groupTypes you want and limit the fields you would like to retrieve.

Filter Syntax:

  • Use attributes with prefix object_ to filter by group type properties
  • Use object_groupTypes to filter by specific group type identifiers (array)
  • Use object_objectOwners to filter by object owners (array)
  • Supports MongoDB query syntax including equality, regex, comparison, and logical operators

Field Selection:

  • Use the fields array to specify which fields to return
  • If fields is not specified, all fields are returned
  • Available fields include: groupType, description, objectOwner, roleMode, allowedRoles, etc.

Pagination and Sorting:

  • Use from and size for pagination
  • Use sortfield and descending for sorting results

Validation Rules:

  • Filter object must be valid MongoDB query syntax
  • Field names in fields array must be valid group type properties
  • from must be a non-negative integer
  • size must be a positive integer

Request​

Responses​

OK - Group Types Setup found matching the filter criteria