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

# Current usage

> Everything you have used and everything you have left, grouped by product: your Email Outreach plan limits and your Lead Finder credits. Check it before a large send or import. For billing cycles and renewal dates, see `GET /v1/account/subscription`.

Requires one of the following scopes: `usage:read`, `all:read`, `all:all`.



## OpenAPI

````yaml /openapi.json get /v1/usage
openapi: 3.0.0
info:
  title: MailBeast Public API
  description: >-
    Task-shaped REST API for campaigns, leads, deliverability, verification and
    lead discovery. Authenticate with an API key (`Authorization: Bearer
    mb_live_…`); the workspace is resolved from the key.
  version: '1'
  contact: {}
servers:
  - url: https://api.mailbeast.ai
security: []
tags:
  - name: API Keys
    description: Create, list and revoke API keys programmatically.
  - name: Campaigns
    description: Create, configure, launch and monitor email campaigns.
  - name: Leads
    description: Add, read, update and bulk-manage a campaign’s leads.
  - name: Workspace
    description: Read usage, subscription and workspace identity.
  - name: Email Accounts
    description: >-
      Connect and manage the sending mailboxes your campaigns send from
      (SMTP/IMAP or native OAuth).
  - name: Analytics
    description: Engagement reporting – per campaign, over time, and across the workspace.
  - name: Lead Finder
    description: >-
      Discover new companies and leads. List past searches and poll a running
      search’s progress.
paths:
  /v1/usage:
    get:
      tags:
        - Workspace
      summary: Current usage
      description: >-
        Everything you have used and everything you have left, grouped by
        product: your Email Outreach plan limits and your Lead Finder credits.
        Check it before a large send or import. For billing cycles and renewal
        dates, see `GET /v1/account/subscription`.


        Requires one of the following scopes: `usage:read`, `all:read`,
        `all:all`.
      operationId: workspace_usage
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponseDto'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorDto'
              example:
                error:
                  type: authentication_error
                  code: unauthenticated
                  message: Missing or invalid API key.
                  status: 401
                  requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f
        '403':
          description: >-
            The key lacks a required scope, or the plan does not include API
            access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorDto'
              example:
                error:
                  type: authorization_error
                  code: permission_denied
                  message: This API key is missing the required scope.
                  status: 403
                  requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f
        '429':
          description: >-
            Rate limit exceeded - retry after the interval in the Retry-After
            header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorDto'
              example:
                error:
                  type: rate_limit_error
                  code: rate_limited
                  message: >-
                    Too many requests. Retry after the interval in the
                    Retry-After header.
                  status: 429
                  requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f
                  retryAfter: 30
      security:
        - ApiKey: []
components:
  schemas:
    UsageResponseDto:
      type: object
      properties:
        emailOutreach:
          description: Your Email Outreach plan usage - the five plan limits.
          allOf:
            - $ref: '#/components/schemas/EmailOutreachUsageDto'
        leadFinder:
          description: >-
            Your Lead Finder usage - a separate product with its own credit
            balance.
          allOf:
            - $ref: '#/components/schemas/LeadFinderUsageDto'
      required:
        - emailOutreach
        - leadFinder
    ApiErrorDto:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBodyDto'
      required:
        - error
    EmailOutreachUsageDto:
      type: object
      properties:
        planName:
          type: string
          example: pro
          description: Your Email Outreach plan.
        limits:
          description: The five Email Outreach plan limits.
          type: array
          items:
            $ref: '#/components/schemas/PlanUsageLimitDto'
      required:
        - planName
        - limits
    LeadFinderUsageDto:
      type: object
      properties:
        credits:
          description: Current Lead Finder credit balance.
          allOf:
            - $ref: '#/components/schemas/LeadFinderCreditsDto'
      required:
        - credits
    ApiErrorBodyDto:
      type: object
      properties:
        type:
          type: string
          example: authorization_error
          description: Broad error class.
        code:
          type: string
          example: permission_denied
          description: Stable machine-readable code to switch on.
        message:
          type: string
          example: This API key is missing the required scope.
        status:
          type: number
          example: 403
        requestId:
          type: string
          example: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f
          description: Correlation id - quote it in support requests.
        details:
          description: Field-level validation messages (present on validation errors).
          example:
            - name should not be empty
          type: array
          items:
            type: string
        retryAfter:
          type: number
          description: Seconds to wait before retrying (present on 429 responses).
          example: 30
      required:
        - type
        - code
        - message
        - status
        - requestId
    PlanUsageLimitDto:
      type: object
      properties:
        used:
          type: number
          example: 1240
          description: Units consumed this period.
        limit:
          type: number
          nullable: true
          example: 5000
          description: The cap, or `null` when unlimited.
        remaining:
          type: number
          nullable: true
          example: 3760
          description: Units left, or `null` when unlimited.
        isUnlimited:
          type: boolean
          example: false
        usagePercentage:
          type: number
          example: 24.8
          description: used / limit × 100 (0 when unlimited).
        limitType:
          type: string
          enum:
            - monthly_emails
            - active_contacts
            - ai_credits
            - email_validation
            - monthly_imports
          example: monthly_emails
      required:
        - used
        - limit
        - remaining
        - isUnlimited
        - usagePercentage
        - limitType
    LeadFinderCreditsDto:
      type: object
      properties:
        used:
          type: number
          example: 1240
          description: Units consumed this period.
        limit:
          type: number
          nullable: true
          example: 5000
          description: The cap, or `null` when unlimited.
        remaining:
          type: number
          nullable: true
          example: 3760
          description: Units left, or `null` when unlimited.
        isUnlimited:
          type: boolean
          example: false
        usagePercentage:
          type: number
          example: 24.8
          description: used / limit × 100 (0 when unlimited).
        limitType:
          type: string
          enum:
            - lead_finder_credits
          example: lead_finder_credits
      required:
        - used
        - limit
        - remaining
        - isUnlimited
        - usagePercentage
        - limitType
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: mb_live_…
      type: http

````

## Related topics

- [Current usage for one limit](/api-reference/workspace/current-usage-for-one-limit.md)
- [Workspace & Usage](/workspace.md)
- [Subscription](/api-reference/workspace/subscription.md)
- [Workspace identity](/api-reference/workspace/workspace-identity.md)
- [Authentication](/authentication.md)
