HEheroiclabs
Console

Get detailed group information.

get/v2/console/group/{id}

Request

  • Base URL
    http://127.0.0.1:7351
  • Auth
    API key in header Authorization

Path parameters

idstring required

The unique identifier of the group.

Response

A successful response.

idstring

The id of a group.

creator_idstring

The id of the user who created the group.

namestring

The unique name of the group.

descriptionstring

A description for the group.

lang_tagstring

The language expected to be a tag which follows the BCP-47 spec.

metadatastring

Additional information stored as a JSON object.

avatar_urlstring

A URL for an avatar image.

openboolean

Anyone can join open groups, otherwise only admins can accept members.

edge_countinteger

The current count of all members in the group.

max_countinteger

The maximum number of members allowed.

create_timestring date-time

The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was created.

update_timestring date-time

The UNIX time (for gRPC clients) or ISO string (for REST clients) when the group was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.