Check your credits balance

Changed on

Returns the credit balance of the account the API key belongs to.

Authentication uses the X-API-Key header like every other endpoint. The api_key query parameter is a legacy alternative kept for backward compatibility; the email query parameter is ignored and the email is always resolved from the key.

get/account

Request

  • Base URL
    https://app.bettercontact.rocks/api/v2
  • URL
    https://app.bettercontact.rocks/api/v2/account
  • Auth
    API key in header X-API-Key

Query parameters

api_keystring

Legacy alternative to the X-API-Key header. Prefer the header.

Response

Credit balance retrieved successfully.

successboolean
credits_leftinteger

Credits remaining on the account, across the whole organisation.

emailstring

Email of the account the API key belongs to.

Example response

{
  "success": true,
  "credits_left": 32377,
  "email": "your_email@mycompany.com"
}

Changes

    • warning

      deleted the query request parameter email

    • info

      api operation id getAccount was added

    • info

      the query request parameter api_key became optional

    • info

      query request parameter api_key was deprecated

    • info

      added the optional property to the response with the status