Get Group By Key

GET 
/api/groups/:key

Get a group by its key.

You can find more information about groups here.

Locale

Group names and descriptions can be specified in multiples languages. These can be set when creating groups or through updates.

The locale request parameter specifies in which language the information should be returned. If no locale is specified, the applications default locale will be used. You can learn more about configuring the default locale here.

Tokens

• A valid AccessToken with ADMIN permissions is required.

Request

Responses

200

Group information.

401

The following error codes correspond to this status:

• ACCESS_TOKEN_EXPIRED: Indicates that the access token is expired.
• ACCESS_TOKEN_INVALID: Indicates that the access token cannot be decoded.
• AUTHENTICATION_REQUIRED: User is not authenticated.

403

The following error codes correspond to this status:

• ROLE_REQUIRED: Principal does not have required role.

404

The following error codes correspond to this status:

• DATABASE_ENTITY_NOT_FOUND: Exception representing a failure to find a database entity.

500

The following error codes correspond to this status:

• ACCESS_TOKEN_ALLOWLIST_READING_FAILURE: Represents an exception indicating a failure when reading the allowlist for an access token cache.
• DATABASE_FAILURE: Exception representing a general failure related to database operations.
• NO_TRANSLATIONS: Exception indicating that no translations are available for a given request.