Get Credit Balances

GET/v2/credits

The live balance of each credit type, so a script or agent can check what it may spend before it spends. Free: no credits. data.<type>.available equals metadata.credits.<type> on credit-spending responses: email_search is spent by email find and reveals (POST /v2/email/find, people enrich and save), email_verification by email verification (POST /v2/email/verify, /v2/email-verifications), phone_search by phone reveals. Any member, with an API key, an OAuth token or a session.

Responses

200 The balances.
401 Missing, unknown or inactive credentials (UNAUTHORIZED).
500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.

curl --request GET \
  --url https://api.getprospect.com/v2/credits \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "email_search": {
      "available": 1180,
      "allowance": 1000,
      "additional": 150,
      "permanent": 30
    },
    "email_verification": {
      "available": 2000,
      "allowance": 2000,
      "additional": 0,
      "permanent": 0
    },
    "phone_search": {
      "available": 40,
      "allowance": 50,
      "additional": 0,
      "permanent": 0
    },
    "reset_at": "2026-11-01T00:00:00.000Z"
  },
  "metadata": {
    "timestamp": "2026-10-08T09:30:00.000Z"
  }
}