Skip to main content
GET
/
v1
/
api
/
enrichment
/
credits
Get enrichment credit balance
curl --request GET \
  --url https://client-api.salesfinity.co/v1/api/enrichment/credits \
  --header 'x-api-key: <api-key>'
{
  "balance": 250
}
Returns the current enrichment credit balance for the team that owns the API key. Each completed email enrichment costs 1 credit. Use this endpoint to check available credits before kicking off enrichment requests — a request with a zero balance is rejected with 402 Payment Required.

​
Response (200)

{
  "balance": 250
}
FieldTypeDescription
balanceintegerNumber of enrichment credits remaining for the team.

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

Current credit balance.

​
balance
integer
required

Number of enrichment credits remaining for the team.

Example:

250