> ## Documentation Index
> Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtener créditos del grupo

> Devuelve el saldo de créditos actual de un grupo concreto. Requiere una clave de API global.



## OpenAPI

````yaml es/api-reference/openapi.json get /api/v1/credits/group
openapi: 3.1.0
info:
  title: API de AthenaHQ
  description: >-
    La API de AthenaHQ ofrece acceso programático para gestionar tus sitios web
    y consultas para optimizar el contenido con IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Servidor de producción
security:
  - apiKey: []
tags:
  - name: Basics
    description: Operaciones principales de la API para gestionar sitios web y consultas
  - name: Metrics
    description: Endpoints de métricas y análisis para monitorizar la visibilidad en IA
  - name: Billing
    description: Endpoints de facturación y créditos para gestionar el uso
  - name: Team Management
    description: Endpoints para gestionar miembros del equipo e invitaciones
  - name: Groups
    description: Endpoints para gestionar grupos de sitios web
  - name: Content
    description: >-
      Endpoints para acceder a los datos del centro de contenidos: pestañas, URL
      monitorizadas y desglose de consultas por URL.
  - name: Pitch Workspace
    description: >-
      Endpoints para acceder a los informes del espacio de propuestas:
      ejecuciones de propuestas con alcance de organización, con competidores,
      consultas, atributos y métricas agregadas.
  - name: Knowledge Base
    description: >-
      Endpoints para leer la base de conocimientos de la marca: datos aprobados
      sobre la marca y los pilares que los organizan.
paths:
  /api/v1/credits/group:
    get:
      tags:
        - Billing
      summary: Obtener créditos del grupo
      description: >-
        Devuelve el saldo de créditos actual de un grupo concreto. Requiere una
        clave de API global.
      operationId: getGroupCredits
      parameters:
        - name: group_id
          in: query
          description: ID del grupo del que se consultarán los créditos
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Respuesta correcta con el saldo de créditos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsResponse'
              example:
                credits:
                  total: 500
                  monthly:
                    balance: 300
                    next_reset_at: 1772227690021
                  one_off:
                    balance: 200
        '400':
          description: 'Solicitud incorrecta: parámetros no válidos'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: group_id is required
        '401':
          description: 'Sin autorización: falta la clave de API o no es válida'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Acceso denegado: se requiere una clave de API global'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'Forbidden: global API key required'
        '404':
          description: Grupo no encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Group not found
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Failed to fetch credits
      security:
        - apiKey: []
components:
  schemas:
    CreditsResponse:
      type: object
      description: Respuesta del saldo de créditos
      required:
        - credits
      properties:
        credits:
          type: object
          required:
            - total
            - monthly
            - one_off
          properties:
            total:
              type: integer
              description: Saldo total de créditos (mensuales y de pago único)
              example: 700
            monthly:
              type: object
              description: Créditos mensuales recurrentes
              required:
                - balance
                - next_reset_at
              properties:
                balance:
                  type: integer
                  description: Saldo actual de créditos mensuales
                  example: 700
                next_reset_at:
                  type: integer
                  description: >-
                    Marca de tiempo en milisegundos del próximo restablecimiento
                    de créditos mensuales
                  example: 1772227690021
            one_off:
              type: object
              description: Créditos comprados en un pago único
              required:
                - balance
              properties:
                balance:
                  type: integer
                  description: Saldo actual de créditos de pago único
                  example: 0
    Error:
      type: object
      description: Objeto de respuesta de error
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error que describe qué ha fallado
          example: Unauthorized
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clave de API para autenticarse. Puedes crear una
        [aquí](https://app.athenahq.ai/organization?tab=api).

````

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