APIHub
Back to Explore

Account API

The Account API provides programmatic access to core Vonage account functions, allowing you to retrieve the current balance, top‑up the account, update account settings, register email senders, and create, list, retrieve, or revoke API secrets associated with a given API key.

Uncategorized
basic
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

841ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/account/get-balance

Get Account Balance

  • api_key (query, required) — Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)
  • api_secret (query, required) — Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)
POST

/account/register-sender

Register an email sender

  • api_key (query, required) — Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)
  • api_secret (query, required) — Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)
POST

/account/settings

Change Account Settings

  • api_key (query, required) — Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)
  • api_secret (query, required) — Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)
POST

/account/top-up

Top Up Account Balance

  • api_key (query, required) — Your Vonage API key. You can find this in the [dashboard](https://dashboard.nexmo.com)
  • api_secret (query, required) — Your Vonage API secret. You can find this in the [dashboard](https://dashboard.nexmo.com)
GET

/accounts/{api_key}/secrets

Retrieve API Secrets

  • api_key (path, required) — The API key to manage secrets for
POST

/accounts/{api_key}/secrets

Create API Secret

  • api_key (path, required) — The API key to manage secrets for
DELETE

/accounts/{api_key}/secrets/{secret_id}

Revoke an API Secret

  • api_key (path, required) — The API key to manage secrets for
  • secret_id (path, required) — ID of the API Secret
GET

/accounts/{api_key}/secrets/{secret_id}

Retrieve one API Secret

  • api_key (path, required) — The API key to manage secrets for
  • secret_id (path, required) — ID of the API Secret

8 endpoints auto-detected

Authentication

This API uses Basic authentication (a username and password).

curl -X GET \
  "https://api.nexmo.com/account/get-balance"

api.nexmo.com · HTTPS only