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

# Get Credit Balance

> Returns the credit balance of the current workspace and what each billable action costs. Every team member may read it; the split into plan and bought credits is shown to an admin only.



## OpenAPI

````yaml https://api.goextrovert.com/client/v2/docs-json get /client/v2/credits
openapi: 3.1.0
info:
  title: Extrovert Client API
  description: >-
    Public API for Extrovert platform integration. Use your API key for
    authentication.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.goextrovert.com/
    description: API Server
security: []
tags: []
paths:
  /client/v2/credits:
    get:
      tags:
        - Credits
      summary: Get Credit Balance
      description: >-
        Returns the credit balance of the current workspace and what each
        billable action costs. Every team member may read it; the split into
        plan and bought credits is shown to an admin only.
      operationId: CreditsClientApiController_getContext
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContextResponseDto'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiErrorResponseDto'
      security:
        - api-key: []
components:
  schemas:
    GetContextResponseDto:
      type: object
      properties:
        status:
          type: string
          const: success
          description: Response status
        data:
          type: object
          properties:
            totalBalance:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Credits available in the workspace wallet.
            planBalance:
              description: >-
                Part of `totalBalance` granted by the plan. Present only for a
                workspace admin.
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            purchasedBalance:
              description: >-
                Part of `totalBalance` that was bought. Present only for a
                workspace admin.
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            actionRates:
              type: array
              items:
                type: object
                properties:
                  actionType:
                    type: string
                    enum:
                      - LEAD_FINDER_PROSPECT_EXPORT
                      - SOCIAL_REACTIONS
                      - INFLUENCER_ENGAGEMENT
                      - COMPANY_PAGE_ENGAGEMENT
                      - SOCIAL_MENTIONS
                      - COMPETITOR_SOCIAL_REACTIONS
                      - JOB_CHANGES
                      - EMPLOYEE_DEPARTURE
                      - JOB_OFFERS
                      - FUNDRAISING
                      - MERGERS_AND_ACQUISITIONS
                      - COMPANY_GROWTH
                      - DEPARTMENT_GROWTH
                      - REPUBLISHED_JOB_OFFERS
                      - RECRUITMENT_CAMPAIGN
                      - COMPANY_REGISTRATION
                      - COMPETITOR_RELATIONSHIPS
                      - COMPETITOR_CUSTOMER_CARE
                    description: Billable product action.
                  rate:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Credits charged per delivered result of this action.
                required:
                  - actionType
                  - rate
              description: What every billable action costs, in catalog order.
            nextPlanAllocationAt:
              description: >-
                When the next plan credit allocation lands. Absent together with
                `nextPlanAllocationAmount` when none is scheduled.
              type: string
              examples:
                - '2025-06-30T14:02:07.456Z'
                - '2025-07-03T08:30:00.000Z'
            nextPlanAllocationAmount:
              description: How many credits the next plan allocation adds.
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - totalBalance
            - actionRates
        message:
          type: string
          description: Success message
          examples:
            - Operation completed successfully
      required:
        - status
        - data
        - message
    ClientApiErrorResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
          enum:
            - error
        data:
          type: object
          description: Response data
          example: null
          nullable: true
        message:
          type: string
          description: Error message
          example: An error occurred while processing the request
      required:
        - status
        - data
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````

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