Get All Groups

Version 4.0.24.20 (latest)

Get information about all groups.

Request

GET /groups
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
fields
string
Requested fields.
page
integer
DEPRECATED. Use limit and offset instead. Return only page N of paginated results
per_page
integer
DEPRECATED. Use limit and offset instead. Return N rows of data per page
limit
integer
Number of results to return. (used with offset and takes priority over page and per_page)
offset
integer
Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
sorts
string
Fields to sort by.
ids
string[]
content_metadata_id
string
Id of content metadata to which groups must have access.
can_add_to_content_metadata
boolean
Select only groups that either can/cannot be given access to content.

Response

200: Group

Datatype
Description
(array)
Group[]
can
object
Operations the current user is able to perform on this object
can_add_to_content_metadata
boolean
Group can be used in content access controls
contains_current_user
boolean
Currently logged in user is group member
external_group_id
string
External Id group if embed group
externally_managed
boolean
Group membership controlled outside of Looker
id
string
Unique Id
include_by_default
boolean
New users are added to this group by default
name
string
Name of group
user_count
integer
Number of users included in this group

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples