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

# Get credits balance



## OpenAPI

````yaml /openapi.json get /external/credits/balance
openapi: 3.1.0
info:
  title: Lensmor API
  version: 0.22.0
  description: >-
    Lensmor Event Intelligence API for event discovery, exhibitor research,
    personnel lookup, credits, and profile matching.
servers:
  - url: https://platform.lensmor.com
security:
  - bearerAuth: []
tags:
  - name: Credits
  - name: Actions
  - name: Events
  - name: Exhibitors
  - name: Personnel
  - name: Contacts
  - name: Profile Matching
paths:
  /external/credits/balance:
    get:
      tags:
        - Credits
      summary: Get credits balance
      operationId: getExternalCreditsBalance
      responses:
        '200':
          description: Credits balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CreditBalance:
      type: object
      required:
        - totalAmount
        - totalBalance
        - subscriptionAmount
        - subscriptionBalance
        - giftAmount
        - giftBalance
        - resetAt
      properties:
        totalAmount:
          type: number
        totalBalance:
          type: number
        subscriptionAmount:
          type: number
        subscriptionBalance:
          type: number
        giftAmount:
          type: number
        giftBalance:
          type: number
        resetAt:
          type:
            - number
            - 'null'
    ApiError:
      type: object
      required:
        - code
        - message
        - errorKey
        - traceId
      properties:
        code:
          type: integer
        message:
          type: string
        errorKey:
          type: string
        traceId:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: User API key

````