Skip to main content
GET
Current usage for one limit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

limitType
enum<string>
required

The limit to read.

Available options:
monthly_emails,
active_contacts,
ai_credits,
email_validation,
monthly_imports,
lead_finder_credits

Response

used
number
required

Units consumed this period.

Example:

1240

limit
number | null
required

The cap, or null when unlimited.

Example:

5000

remaining
number | null
required

Units left, or null when unlimited.

Example:

3760

isUnlimited
boolean
required
Example:

false

usagePercentage
number
required

used / limit × 100 (0 when unlimited).

Example:

24.8

limitType
enum<string>
required
Available options:
monthly_emails,
active_contacts,
ai_credits,
email_validation,
monthly_imports,
lead_finder_credits
Example:

"monthly_emails"