# Retrieve gamification settings

`GET https://api.cademi.com.br/api/v3/settings/gamification`

Operation ID: `settings.gamification.get` · API v3

Returns the gamification settings of the account: ranking visibility, the scoring rule for comments, and the triggers that award points.

Requires the `gamification.read` permission; `settings.read` does not grant access to this group.

The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating these settings to avoid overwriting a newer version.

Required permissions: `gamification.read`.

## Responses

### 200

Returns the gamification settings.

Body: `data`: SettingsGamification.

Fields of SettingsGamification:

| Field | Type | Required | Description |
|---|---|---|---|
| `comment_scoring` | string, one of `once`, `unlimited` | yes | Whether comments earn points once per lesson (once) or every time (unlimited). |
| `defaults` | object | yes |  |
| `enabled` | boolean | yes |  |
| `object` | string, one of `settings` | yes |  |
| `replica` | object | yes |  |
| `revision` | string | yes |  |
| `show_full_name` | boolean | yes |  |
| `show_to_students` | boolean | yes |  |
| `triggers` | object | yes | One trigger per scoring action. points must be at least 1; use enabled to turn a trigger off. |

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

Full schema: https://cademi.dev/openapi/v3.json
