> ## Documentation Index
> Fetch the complete documentation index at: https://ajuda.memberkit.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Retorna o ranking

> Retorna o ranking dos membros.

Traz os primeiros colocados e a posição do próprio membro. Com `classroom`, o ID precisa ser de uma das turmas do membro; com outro ID, a lista vem vazia.


## OpenAPI

````yaml headless/openapi.yml GET /api/headless/v1/ranking
openapi: 3.1.0
info:
  title: MemberKit Headless
  version: 1.0.0
servers: []
security:
  - bearer: []
    headlessKey: []
tags:
  - name: academy
  - name: auth
  - name: onboarding
  - name: courses
  - name: categories
  - name: banners
  - name: bookmarks
  - name: kv
  - name: comments
  - name: quizzes
  - name: search
  - name: ranking
  - name: profile
  - name: certificates
  - name: contact_messages
  - name: notifications
  - name: uploads
  - name: assistant
  - name: community
  - name: lessons
paths:
  /api/headless/v1/ranking:
    get:
      tags:
        - ranking
      summary: Retorna o ranking
      description: Retorna o ranking dos membros.
      operationId: getRanking
      parameters:
        - name: classroom
          in: query
          required: false
          schema:
            oneOf:
              - type: integer
              - type: string
                enum:
                  - enrolled
                  - all
          description: >-
            ID da turma, enrolled (padrão) para as turmas do membro ou all para
            todas.
        - name: top
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: >-
            Traz as posições até este número. A posição do próprio membro pode
            trazer mais um item.
      responses:
        '200':
          description: Ranking
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ranking'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/SubscriptionSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Ranking:
      allOf:
        - $ref: '#/components/schemas/List'
        - type: object
          required:
            - data
            - classrooms
          properties:
            data:
              type: array
              items:
                type: object
                required:
                  - position
                  - score
                  - user
                  - mine
                  - comments_count
                  - ratings_count
                  - completed_lessons_count
                  - progress
                properties:
                  position:
                    type: integer
                  score:
                    type: integer
                    description: Pontos somados nas turmas escolhidas em classroom.
                  mine:
                    type: boolean
                    description: >-
                      Se a entrada é do próprio membro, que vem mesmo fora do
                      top.
                  user:
                    $ref: '#/components/schemas/Author'
                  comments_count:
                    type: integer
                  ratings_count:
                    type: integer
                  completed_lessons_count:
                    type: integer
                    description: Aulas concluídas nos cursos das turmas escolhidas.
                  progress:
                    type: integer
                    description: >-
                      Média do progresso nos cursos das turmas escolhidas, em
                      porcentagem.
            classrooms:
              type: array
              description: Turmas que o membro pode escolher em classroom.
              items:
                $ref: '#/components/schemas/NamedRef'
    List:
      type: object
      description: Formato de todas as listas, com os itens em data.
      required:
        - page
        - total_pages
      properties:
        page:
          type: integer
          description: Página atual.
        total_pages:
          type: integer
          description: Total de páginas; 1 numa lista vazia.
    Author:
      type: object
      description: Membro como os outros membros o veem.
      required:
        - id
        - full_name
        - avatar_url
      properties:
        id:
          type: integer
        full_name:
          type: string
        avatar_url:
          $ref: '#/components/schemas/Avatar'
    NamedRef:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
        name:
          type: string
    Error:
      type: object
      description: Formato de todos os erros.
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          description: Código do erro.
          enum:
            - subscription_suspended
            - onboarding_required
            - course_onboarding_required
            - access_expired
            - content_locked
            - comments_disabled
            - unprocessable_certificate
            - unauthenticated
            - invalid_credentials
            - invalid_token
            - invalid_headless_key
            - session_replaced
            - session_revoked
            - account_locked
            - forbidden
            - not_found
            - missing_parameter
            - malformed_request
            - validation_failed
            - invalid_signed_id
            - rate_limited
            - idempotency_key_reused
            - request_in_progress
            - assistant_unavailable
            - quiz_required
        message:
          type: string
        request_id:
          type: string
        errors:
          type: object
          description: Erros de cada campo, presentes com o código validation_failed.
          additionalProperties:
            type: array
            items:
              type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                  description: Motivo do erro, como blank, taken, too_short ou invalid.
                message:
                  type: string
                  description: Mensagem pronta para exibir, no idioma da área de membros.
    Avatar:
      type:
        - string
        - 'null'
  responses:
    Unauthenticated:
      description: >-
        Membro não autenticado (code unauthenticated, invalid_token,
        session_replaced, session_revoked ou invalid_headless_key).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    SubscriptionSuspended:
      description: Assinatura da área de membros suspensa (code subscription_suspended).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Limite de requisições atingido (code rate_limited).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
    headlessKey:
      type: apiKey
      in: header
      name: X-Memberkit-Headless-Key
      description: >-
        Chave headless da área de membros, em Configurações. É pública e vai em
        todas as requisições, inclusive nas que levam o token do membro.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.