Workspace

Current usage for one limit

Just one limit (used/limit/remaining/percentage/isUnlimited) - handy when you only care about the one you’re about to spend.

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

get/v1/usage/{limitType}

Request

  • Base URL: https://api.mailbeast.ai
  • URL: https://api.mailbeast.ai/v1/usage/{limitType}
  • Auth: HTTP bearer

Path parameters

limitType'monthly_emails' | 'active_contacts' | 'ai_credits' | 'email_validation' | 'lead_finder_credits' required

The limit to read.

Response

usednumber required

Units consumed this period.

limitnumber nullable required

The cap, or null when unlimited.

remainingnumber nullable required

Units left, or null when unlimited.

isUnlimitedboolean required
usagePercentagenumber required

used / limit × 100 (0 when unlimited).

limitType'monthly_emails' | 'active_contacts' | 'ai_credits' | 'email_validation' | 'lead_finder_credits' required

Example response

{
  "used": 1240,
  "limit": 5000,
  "remaining": 3760,
  "usagePercentage": 24.8,
  "limitType": "monthly_emails"
}

Changes

No recorded changes to this operation across all 1 revision of this API.