> ## 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.

# Get Group Credits

> Returns the current credit balance for a specific group. Requires a global API key.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/credits/group
openapi: 3.1.0
info:
  title: AthenaHQ API
  description: >-
    AthenaHQ API provides programmatic access to manage your websites and
    prompts for AI-powered content optimization.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Production server
security:
  - apiKey: []
tags:
  - name: Basics
    description: Core API operations for managing websites and prompts
  - name: Metrics
    description: Metrics and analytics endpoints for tracking AI visibility
  - name: Billing
    description: Billing and credits endpoints for managing usage
  - name: Team Management
    description: Endpoints for managing team members and invitations
  - name: Groups
    description: Endpoints for managing groups of websites
  - name: Content
    description: >-
      Endpoints for accessing Content Hub data — tabs, tracked URLs, and per-URL
      prompt breakdowns.
  - name: Pitch Workspace
    description: >-
      Endpoints for accessing pitch workspace reports — org-scoped pitch runs
      with competitors, prompts, attributes, and aggregate metrics.
  - name: Knowledge Base
    description: >-
      Endpoints for reading the brand Knowledge Base — approved brand facts and
      the pillars that organize them.
paths:
  /api/v1/credits/group:
    get:
      tags:
        - Billing
      summary: Get Group Credits
      description: >-
        Returns the current credit balance for a specific group. Requires a
        global API key.
      operationId: getGroupCredits
      parameters:
        - name: group_id
          in: query
          description: The ID of the group to retrieve credits for
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response with credit balance
          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: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: group_id is required
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - Global API key required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 'Forbidden: global API key required'
        '404':
          description: Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Group not found
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Failed to fetch credits
      security:
        - apiKey: []
components:
  schemas:
    CreditsResponse:
      type: object
      description: Credit balance response
      required:
        - credits
      properties:
        credits:
          type: object
          required:
            - total
            - monthly
            - one_off
          properties:
            total:
              type: integer
              description: Total credit balance (monthly + one-off)
              example: 700
            monthly:
              type: object
              description: Monthly recurring credits
              required:
                - balance
                - next_reset_at
              properties:
                balance:
                  type: integer
                  description: Current monthly credit balance
                  example: 700
                next_reset_at:
                  type: integer
                  description: Timestamp in milliseconds when monthly credits will reset
                  example: 1772227690021
            one_off:
              type: object
              description: One-off purchased credits
              required:
                - balance
              properties:
                balance:
                  type: integer
                  description: Current one-off credit balance
                  example: 0
    Error:
      type: object
      description: Error response object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message describing what went wrong
          example: Unauthorized
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can create one
        [here](https://app.athenahq.ai/organization?tab=api).

````