FIfindymail
Usage

Get remaining credits

Changed on

Returns the remaining credit balance of your team. Credits belong to the team owner, so every team member gets the same balance.

On a usage-based plan (Individual, Team, Scale), has_capacity tells whether your team can still run requests. On a credit-based plan it is null: rely on credits instead.

get/api/credits

Request

  • Base URL
    https://app.findymail.com
  • URL
    https://app.findymail.com/api/credits
  • Auth
    HTTP bearer

Query parameters

typestring

The balance returned in credits: finder or verifier. Defaults to finder.

Example:finder

Response

OR

Example response

{
  "credits": 150,
  "email": "john@website.com",
  "has_capacity": null,
  "verifier_credits": 100
}

Changes

  • b6b5ecb380dbRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter type

  • ae7fddf16bf9Revision changes
    • info

      api tag Usage added

    • info

      api tag User removed