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

# Credit count

> Check the remaining credit balance for your Airscale workspace. Rate limit: No endpoint-specific rate limit is documented.

Read the remaining credit balance for the workspace associated with your API key before starting paid enrichment work.

> [!NOTE]
>
> Send no request body. Checking the balance is free and does not debit Airscale credits.

An invalid or missing key returns `401 Unauthorized`. Confirm the current key in the Airscale dashboard and update your server-side secret; rotate it only if it was exposed.

## Next step

Use your authenticated client to [find people](https://docs.airscale.io/api-reference/find-people.md), or review [Authentication](https://docs.airscale.io/api-reference/authentication.md) before sending requests.


## OpenAPI

````yaml openapi.json POST /v1/credits
openapi: 3.1.0
info:
  title: Airscale Public API
  version: '2026-09-11'
  description: >-
    Search, enrich, resolve public business data, and monitor job changes with
    Airscale.
  x-airscale-source-repository: ViceScale/airscale-code
  x-airscale-source-sha: 1de19e1b70a052a4b8d9c2075021a7e5e7a94d51
servers:
  - url: https://api.airscale.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search and discovery
    description: Search people, companies, and the web.
  - name: Contact data
    description: Find professional and personal contact data.
  - name: Profiles and reverse lookup
    description: Extract profiles or resolve a person from known contact data.
  - name: Post engagement
    description: Retrieve and enrich people who liked or commented on LinkedIn posts.
  - name: LinkedIn content
    description: >-
      Search LinkedIn posts, read profile and company feeds, and retrieve
      profile comments and comment reactions.
  - name: Job change monitoring
    description: Track LinkedIn profiles and receive job-change events.
  - name: New hire monitoring
    description: Watch companies or the market for people who start a matching role.
  - name: Post engagement monitoring
    description: >-
      Follow LinkedIn company pages and profiles and receive the people who
      engage with their posts.
  - name: Account
    description: Inspect workspace account state.
  - name: Miscellaneous
    description: >-
      Find website technologies and check WhatsApp availability, Meta ads, and
      email deliverability.
paths:
  /v1/credits:
    post:
      tags:
        - Account
      summary: Get workspace credit balance
      description: >-
        Returns the current Airscale credit balance for the authenticated
        workspace.
      operationId: getCredits
      responses:
        '200':
          description: The current workspace credit balance.
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - response
                additionalProperties: false
                properties:
                  status:
                    type: string
                    const: success
                  response:
                    type: object
                    required:
                      - credits
                    additionalProperties: false
                    properties:
                      credits:
                        type: number
              examples:
                success:
                  summary: Credit balance
                  value:
                    status: success
                    response:
                      credits: 1200
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          description: >-
            The credit balance could not be retrieved because of an unexpected
            server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The credit balance is temporarily unavailable. Try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    Unauthorized:
      description: The Bearer token is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      additionalProperties: true
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Use an Airscale workspace API key. Never expose the key in client-side
        code.

````

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