> ## 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 a área de membros

> Retorna o nome, a marca e os recursos da área de membros.

É a primeira chamada de um site: não precisa de login, só da chave headless, e devolve o que a tela de login precisa para aparecer com a marca certa.

A chamada continua respondendo quando a assinatura da área de membros está suspensa, para que a tela de manutenção também apareça com a marca.


## OpenAPI

````yaml headless/openapi.yml GET /api/headless/v1/academy
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/academy:
    get:
      tags:
        - academy
      summary: Retorna a área de membros
      description: Retorna o nome, a marca e os recursos da área de membros.
      operationId: getAcademy
      responses:
        '200':
          description: Área de membros encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Academy'
        '401':
          $ref: '#/components/responses/InvalidHeadlessKey'
        '429':
          $ref: '#/components/responses/RateLimited'
      security:
        - headlessKey: []
components:
  schemas:
    Academy:
      type: object
      required:
        - name
        - locale
        - time_zone
        - branding
        - theme
        - features
      properties:
        name:
          type: string
        locale:
          type: string
        time_zone:
          type: string
          description: Fuso horário no formato IANA, como America/Sao_Paulo.
        branding:
          type: object
          required:
            - logo_url
            - favicon_url
            - background_url
            - nav_background_url
          properties:
            logo_url:
              type:
                - string
                - 'null'
            favicon_url:
              type:
                - string
                - 'null'
            background_url:
              type:
                - string
                - 'null'
              description: Imagem de fundo das telas de login.
            nav_background_url:
              type:
                - string
                - 'null'
              description: Imagem de fundo da barra de navegação.
        theme:
          type: object
          required:
            - brand_color
            - navbar_primary_color
            - navbar_secondary_color
            - background_color
          properties:
            brand_color:
              type: string
            navbar_primary_color:
              type: string
              description: Cor inicial do degradê da barra de navegação.
            navbar_secondary_color:
              type: string
              description: Cor final do degradê da barra de navegação.
            background_color:
              type: string
              description: Cor de fundo do tema escolhido, útil para a splash screen.
        features:
          type: object
          required:
            - points_currency
            - community
            - certificates
            - ai_assistant
          properties:
            points_currency:
              type: string
              description: Nome dos pontos exibido no ranking e no perfil, como XP.
            community:
              type: boolean
              description: Se a área de membros tem alguma comunidade.
            certificates:
              type: boolean
              description: Se a área de membros emite certificados.
            ai_assistant:
              type: object
              required:
                - enabled
                - name
              properties:
                enabled:
                  type: boolean
                name:
                  type:
                    - string
                    - 'null'
    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.
  responses:
    InvalidHeadlessKey:
      description: Chave headless ausente ou inválida (code invalid_headless_key).
      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.