Stay organized with collections
Save and categorize content based on your preferences.
Version 4.0.25.14 (latest)
Search groups include hierarchy
Returns all group records that match the given search criteria, and attaches
associated role_ids and parent group_ids.
If multiple search params are given and filter_or is FALSE or not specified,
search params are combined in a logical AND operation.
Only rows that match all search param criteria will be returned.
If filter_or is TRUE, multiple search params are combined in a logical OR operation.
Results will include rows that match any of the search criteria.
String search params use case-insensitive matching.
String search params can contain % and '_' as SQL LIKE pattern match wildcard expressions.
example="dan%" will match "danger" and "Danzig" but not "David"
example="D_m%" will match "Damage" and "dump"
Integer search params can accept a single value or a comma separated list of values. The multiple
values will be combined under a logical OR operation - results will match at least one of
the given values.
Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match
or exclude (respectively) rows where the column is null.
Boolean search params accept only "true" and "false" as values.
Request
GET
/groups/search/with_hierarchy
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.
limit
integer
Number of results to return (used with `offset`).
offset
integer
Number of results to skip before returning any (used with `limit`).
sorts
string
Fields to sort by.
filter_or
boolean
Combine given search criteria in a boolean OR expression
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# Search Groups with Hierarchy\n\nVersion 4.0.25.14 (latest)\n\n### Search groups include hierarchy\n\nReturns all group records that match the given search criteria, and attaches\nassociated role_ids and parent group_ids.\n\nIf multiple search params are given and `filter_or` is FALSE or not specified,\nsearch params are combined in a logical AND operation.\nOnly rows that match *all* search param criteria will be returned.\n\nIf `filter_or` is TRUE, multiple search params are combined in a logical OR operation.\nResults will include rows that match **any** of the search criteria.\n\nString search params use case-insensitive matching.\nString search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.\nexample=\"dan%\" will match \"danger\" and \"Danzig\" but not \"David\"\nexample=\"D_m%\" will match \"Damage\" and \"dump\"\n\nInteger search params can accept a single value or a comma separated list of values. The multiple\nvalues will be combined under a logical OR operation - results will match at least one of\nthe given values.\n\nMost search params can accept \"IS NULL\" and \"NOT NULL\" as special expressions to match\nor exclude (respectively) rows where the column is null.\n\nBoolean search params accept only \"true\" and \"false\" as values.\n\nRequest\n-------\n\nGET /groups/search/with_hierarchy \nDatatype \nDescription \nRequest \nHTTP Request \nquery \nHTTP Query \nExpand HTTP Query definition... \nfields \nstring \nRequested fields. \nlimit \ninteger \nNumber of results to return (used with \\`offset\\`). \noffset \ninteger \nNumber of results to skip before returning any (used with \\`limit\\`). \nsorts \nstring \nFields to sort by. \nfilter_or \nboolean \nCombine given search criteria in a boolean OR expression \nid \nstring \nMatch group id. \nname \nstring \nMatch group name. \nexternal_group_id \nstring \nMatch group external_group_id. \nexternally_managed \nboolean \nMatch group externally_managed. \nexternally_orphaned \nboolean \nMatch group externally_orphaned.\n\nResponse\n--------\n\n### 200: Group\n\nDatatype \nDescription \n(array) \n[GroupHierarchy](/looker/docs/reference/looker-api/latest/types/GroupHierarchy)\\[\\] \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object \ncan_add_to_content_metadata \nboolean \nGroup can be used in content access controls \ncontains_current_user \n*lock* \nboolean \nCurrently logged in user is group member \nexternal_group_id \n*lock* \nstring \nExternal Id group if embed group \nexternally_managed \n*lock* \nboolean \nGroup membership controlled outside of Looker \nid \n*lock* \nstring \nUnique Id \ninclude_by_default \n*lock* \nboolean \nNew users are added to this group by default \nname \nstring \nName of group \nuser_count \n*lock* \ninteger \nNumber of users included in this group \nparent_group_ids \nstring\\[\\] \nrole_ids \nstring\\[\\] \n\n### 400: Bad Request\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 404: Not Found\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 429: Too Many Requests\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link"]]
