List Groups
const url = 'https://example.com/taxonomy/v1/organisations/example/groups';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/taxonomy/v1/organisations/example/groupsReturns a paginated list of groups within an organisation. Supports parent_group_id filter to list direct children of a group.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The organisation to list groups for, or ”-” (AIP-159) to list across organisations.
Callers using ”-” receive exactly the groups they can reach — those covered by a scope at
which they hold the required permission, plus the ancestors on the path to them — with
total_size and page tokens computed over that same reachable set.
Query Parameters
Section titled “Query Parameters ”The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 20 groups will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token, received from a previous ListGroups call.
Provide this to retrieve the subsequent page. When paginating,
all other parameters provided to ListGroups must match the call
that provided the page token.
AIP-160 filter expression. Filterable fields: create_time, description, display_name, id, name, organisation_id, parent_group_id, state, state_origin, update_time.
AIP-132 order_by expression. Sortable fields: create_time, display_name, name, state, state_origin, update_time.
AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).
Responses
Section titled “ Responses ”OK
ListGroupsResponse
Response message for ListGroups.
object
The list of groups
Group resource: a folder that organises workspaces within an organisation
object
The unique identifier of the group
The organisation this group belongs to
The handle of the group, e.g. “platform-team”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Parent-scoped-unique. Used to address the group by name or id.
A human-readable label for the group, e.g. “Platform Team”. Free text in any script. Never used to address the group. Optional; defaults to the handle (name) when omitted.
An optional description of the group
Optional self-referential parent; empty = root-level group under the organisation
Created Timestamp
The timestamp when the group was created
Updated Timestamp
Timestamp when the group was last updated
Lifecycle State
This group’s own lifecycle state. Changed only through the lifecycle verbs, never by update.
Effective Lifecycle State
The state this group actually experiences, accounting for suspension inherited from its parent groups or organisation. A group whose own state is active reports an effective state of suspended while any ancestor is suspended. An archived group always reports archived.
Archived Timestamp
The instant the group entered the archived state. Unset unless the group is archived.
State Origin
Whether the current state was set directly on this resource or cascaded from an ancestor. Provenance for audit and display.
A token, which can be sent as page_token to retrieve the next page.
If this field is empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "groups": [ { "state": "TAXONOMY_RESOURCE_STATE_UNSPECIFIED", "effective_state": "TAXONOMY_RESOURCE_STATE_UNSPECIFIED", "state_origin": "TAXONOMY_STATE_CHANGE_ORIGIN_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}