List Groups

GET

/taxonomy/v1/organisations/{organisation}/groups

curl --request GET \
  --url https://example.com/taxonomy/v1/organisations/example/groups

Returns a paginated list of groups within an organisation. Supports parent_group_id filter to list direct children of a group.

Parameters

Path Parameters

organisation

required

string

The organisation to list groups for

Query Parameters

page_size

integer format: int32

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.

page_token

string

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.

filter

string

AIP-160 filter expression, e.g. ‘parent_group_id = “uuid”’ to list direct children of a specific group

order_by

string

AIP-132 order_by expression, e.g. ‘name asc’

Responses

200

OK

Media type application/json

ListGroupsResponse

Response message for ListGroups. Note: This API intentionally omits total_size from list responses. Keyset pagination does not support efficient total count computation (COUNT(*) requires a full table scan). Per AIP-158, total_size is optional.

object

groups

The list of groups

Array<object>

Group resource — a folder that organises workspaces within an organisation

object

id

The unique identifier of the group

stringOutput only

organisation_id

The organisation this group belongs to

stringOutput only

name

required

The display name of the group

string

description

An optional description of the group

string

parent_group_id

Optional self-referential parent; empty = root-level group under the organisation

string

created

Created Timestamp

The timestamp when the group was created

string format: date-time Output only

updated

Updated Timestamp

Timestamp when the group was last updated

string format: date-time Output only

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

string

Example ^generated

{
  "groups": [
    {
      "name": "example",
      "description": "example",
      "parent_group_id": "example"
    }
  ],
  "next_page_token": "example"
}

default

Default error response

Media type application/json

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

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

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.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}