> ## Documentation Index
> Fetch the complete documentation index at: https://trophy-ci-i18n-auto-translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get level summary for a points system

> Get a breakdown of the number of users at each level in a points system.



## OpenAPI

````yaml https://api.trophy.so/v1/openapi get /points/{key}/level-summary
openapi: 3.1.0
info:
  title: Trophy
  version: 1.19.0
servers:
  - x-fern-server-name: Application API
    url: https://api.trophy.so/v1
    description: Application API
security: []
paths:
  /points/{key}/level-summary:
    servers:
      - url: https://api.trophy.so/v1
        description: Application API
    parameters:
      - $ref: '#/components/parameters/TenantId'
    get:
      tags:
        - Points
      summary: Get level summary for a points system
      description: Get a breakdown of the number of users at each level in a points system.
      operationId: points_level_summary
      parameters:
        - name: key
          in: path
          description: Key of the points system.
          required: true
          schema:
            type: string
          example: points-system-key
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PointsLevelSummaryResponse'
              examples:
                Successful operation:
                  value:
                    - level:
                        id: 1140fe51-6bce-4b44-b0ad-bddc4e123534
                        key: bronze
                        name: Bronze
                        description: Starting level
                        badgeUrl: https://example.com/bronze.png
                        points: 0
                      users: 5012
                    - level:
                        id: 2240fe51-6bce-4b44-b0ad-bddc4e123534
                        key: silver
                        name: Silver
                        description: Mid-tier level
                        badgeUrl: null
                        points: 50
                      users: 1501
                    - level:
                        id: 3340fe51-6bce-4b44-b0ad-bddc4e123534
                        key: gold
                        name: Gold
                        description: Top level
                        badgeUrl: https://example.com/gold.png
                        points: 200
                      users: 102
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Points system not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: No levels configured on the points system
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: javascript
          source: >
            import { TrophyApiClient } from '@trophyso/node';


            const trophy = new TrophyApiClient({
              apiKey: 'YOUR_API_KEY'
            });


            const response = await
            trophy.points.levelSummary("points-system-key");
        - lang: python
          source: |
            from trophy import TrophyApi

            client = TrophyApi(api_key='YOUR_API_KEY')

            response = client.points.level_summary(key="points-system-key")
        - lang: go
          source: >
            import (
              "context"

              trophyclient "github.com/trophyso/trophy-go/client"
              "github.com/trophyso/trophy-go/option"
            )


            client := trophyclient.NewClient(
              option.WithApiKey("YOUR_API_KEY"),
            )


            response, err := client.Points.LevelSummary(context.TODO(),
            "points-system-key")
components:
  parameters:
    TenantId:
      name: Tenant-ID
      in: header
      description: >-
        The tenant identifier for multi-tenant organisations. Required when the
        organisation has multi-tenancy enabled. The value should be your
        internal ID for the tenant. Ignored for single-tenant organisations.
      required: false
      schema:
        type: string
      example: customer_12345
  schemas:
    PointsLevelSummaryResponse:
      title: PointsLevelSummaryResponse
      type: array
      description: A breakdown of users by level in a points system.
      items:
        type: object
        properties:
          level:
            $ref: '#/components/schemas/PointsLevel'
          users:
            type: integer
            description: The number of users currently at this level
        required:
          - level
          - users
    ErrorBody:
      title: ErrorBody
      type: object
      properties:
        error:
          type: string
      required:
        - error
    PointsLevel:
      title: PointsLevel
      type: object
      description: A level within a points system.
      properties:
        id:
          type: string
          description: The ID of the level
        key:
          type: string
          description: The unique key of the level
        name:
          type: string
          description: The name of the level
        description:
          type: string
          description: The description of the level
        badgeUrl:
          type:
            - string
            - 'null'
          description: The URL of the badge image for the level
        points:
          type: integer
          description: The points threshold required to reach this level
      required:
        - id
        - key
        - name
        - description
        - badgeUrl
        - points
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````