Get Group

GET

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

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

Returns a group by unique ID within an organisation

Parameters

Path Parameters

organisation

required

string

The organisation the group belongs to

id

required

string

The unique identifier of the group to retrieve

Responses

200

OK

Media type application/json

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

Example ^generated

{
  "name": "example",
  "description": "example",
  "parent_group_id": "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"
    }
  ]
}