Nexmo

Account API

Enables users to manage their Vonage API Account by programmable means. More information is available here: .

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Enables users to manage their Vonage API Account by programmable means. More information is available here: .

Endpoints 8

Balance

  • GETGet Account Balancehttps://rest.nexmo.com/account/get-balance?api_key=abcd1234&api_secret=ABCDEFGH01234abcRetrieve the current balance of your Vonage API account
  • POSTTop Up Account Balancehttps://rest.nexmo.com/account/top-up?api_key=abcd1234&api_secret=ABCDEFGH01234abcYou can top up your account using this API when you have enabled auto-reload in the dashboard. The amount added by the top-up operation will be the same…

Configuration

  • POSTRegister an email senderhttps://rest.nexmo.com/account/register-sender?api_key=abcd1234&api_secret=ABCDEFGH01234abcRegister an email sender with an API Key for using email with Verify V2.
  • POSTChange Account Settingshttps://rest.nexmo.com/account/settings?api_key=abcd1234&api_secret=ABCDEFGH01234abcUpdate the default webhook URLs associated with your account: * Callback URL for incoming SMS messages * Callback URL for delivery receipts Note that the URLs…

Secret Management

  • GETRetrieve API Secrets/accounts/:api_key/secrets
  • POSTCreate API Secret/accounts/:api_key/secrets
  • GETRetrieve one API Secret/accounts/:api_key/secrets/:secret_id
  • DELETERevoke an API Secret/accounts/:api_key/secrets/:secret_id

API details

Base URL
https://api.nexmo.com
Authentication
HTTP Basic authentication (username and password)
Operations
8 operations on 6 pathsPOST 4GET 3DELETE 1
Main resources
Secret Management 4Balance 2Configuration 2
Response formats
application/json application/xml
Description format
OpenAPI 3.0.2, API version 1.0.4
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Account API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Account API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Account Balance” (GET https://rest.nexmo.com/account/get-balance?api_key=abcd1234&api_secret=ABCDEFGH01234abc), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Account API?

Enables users to manage their Vonage API Account by programmable means. More information is available here: . It is listed under Other and has 8 endpoints.

Who publishes the Account API?

It is listed from Nexmo's public API description (an OpenAPI document), not published by Nexmo on Swastik Codes. Anyone who controls nexmo.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Account API?

Requests go to https://api.nexmo.com. Endpoint paths are added to this base URL.

How do I authenticate with the Account API?

With HTTP Basic authentication (username and password).

How many endpoints does the Account API have?

8 operations on 6 paths (4 POST, 3 GET, 1 DELETE). The largest groups are Secret Management, Balance, Configuration.

Is forking the Account API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.