Credits
The Credits object shows how many credits your account has and what each action costs.
GET /contacts/credits returns this object. For example, before your workflow unlocks the email address of the head of sales at Bergquell Mineralbrunnen, it checks here whether your credits are enough.
The number in balance applies to your whole account, and the dashboard shows it in the Credits window under Available credits.
Credits in the API describes which calls cost credits. Where credits come from and how you buy more is covered under Credits.
Request
The request is free, doesn't change your credits, and needs neither a particular plan nor a contact setup.
You need the Visitor Intelligence key, which admins find under Menu > Integrations > API. The Enrichment and Data Layer keys don't work here.
curl "https://hub.webmetic.de/contacts/credits" \
-H "Authorization: wmtc_YOUR_API_KEY"Fields
Both fields are always present and never null, and costs always contains the same four fields.
| Field | Type | Description |
|---|---|---|
balance | integer | How many credits your account has right now |
costs | object | Cost per action in credits, the same for every account |
costs.search | integer | Searching for contacts. The search is currently free |
costs.email | integer | Unlocking the email address, with the LinkedIn profile when one exists |
costs.phone | integer | Unlocking the phone numbers |
costs.email_phone | integer | Unlocking email and phone in one call. The sum of costs.email and costs.phone |
Rules
These rules apply to the values:
- Whole number:
balanceis always a whole number and never negative. - No credits: If your account never received credits or has used them all,
balanceis0, and that's not an error. Your account only gets the welcome bonus once you set up contacts. - No expiry: Credits don't expire, and Webmetic doesn't reset them each month. The monthly credits of Starter and Growth are added to the ones you have.
- One value:
balancedoesn't split credits by origin, such as welcome bonus, plan, or purchase. The API returns no history of the credits you used. - List values:
costsshows what a new unlock costs. Data you already unlocked and data types Webmetic doesn't deliver cost nothing. What a call deducted is in thecredits_usedfield of its response, as described under Contact. - Not enough credits: If your credits aren't enough,
/contacts/revealand/contacts/findanswer with status402and the codeINSUFFICIENT_CREDITS.detail.availablein the error has the same value asbalance, anddetail.requiredgives the credits the action needs. For details, see Errors.
Used by
- Endpoint:
GET /contacts/credits - Responses:
credits_remainingin/contacts/search,/contacts/reveal, and/contacts/find, the same value asbalanceafter the call - AI assistant: The AI assistant also uses the same credits with the tool
reveal_contact