The Vonage Business Cloud Account API enables you to retrieve information about accounts. Your application must subscribe to the Provisioning API suite to use this API.
Bring your own key. This API needs your own Vonage Account API key - get one from the provider, add it once below, and the proxy injects it on every call. Your OmniStream plan covers the unified SDK, key storage, and proxy - the provider's own rate limits still apply to your key.
This is a community listing. If you own this API, you can request ownership.
npm install omnistream-sdkimport { OmniClient } from "omnistream-sdk";
const omni = new OmniClient({ token: process.env.OMNI_KEY! });
// One key reaches every API on the marketplace.
const data = await omni.call("vonage/AccountCtrl.getAccountServicesByAccountID");One install, one key - the same client calls every API on the marketplace.
The Vonage Business Cloud account ID
Get account data by ID
Get account locations data by account ID
Get location data by account ID and location ID
/**
* VonageAccountAPI - generated by OmniStream from Vonage Account API's OpenAPI spec.
* One typed method per endpoint. A single Omni key reaches the API.
*/
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/vonage";
export class VonageAccountAPIError extends Error {
status: number;
code?: string;
constructor(status: number, code: string | undefined, message?: string) {
super(message || `VonageAccountAPI error ${status}`);
this.name = "VonageAccountAPIError";
this.status = status;
this.code = code;
}
}
export interface VonageAccountAPIOptions {
baseUrl?: string;
fetch?: typeof fetch;
timeoutMs?: number;
}
export class VonageAccountAPI {
/** @param token Your OmniStream key (one key for every API). */
constructor(private token: string, private opts: VonageAccountAPIOptions = {}) {
if (!token) throw new Error("VonageAccountAPI: token is required");
}
rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;
private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
const f = this.opts.fetch ?? globalThis.fetch;
const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
const headers: Record<string, string> = { "x-omni-key": this.token };
if (body !== undefined) headers["content-type"] = "application/json";
const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
this.rateLimit = {
remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
};
const data = await res.json().catch(() => ({}));
if (!res.ok) throw new VonageAccountAPIError(res.status, data?.error?.code, data?.error?.message);
return data.data ?? data;
}
/** Get account data by ID */
accountCtrlGetAccountServicesByAccountID(params: { "account_id": number }): Promise<any> {
return this._request("GET", "/api/accounts/{account_id}", { params });
}
/** Get account locations data by account ID */
accountCtrlGetLocationsByAccountID(params: { "account_id": number }): Promise<any> {
return this._request("GET", "/api/accounts/{account_id}/locations", { params });
}
/** Get location data by account ID and location ID */
accountCtrlGetLocationByID(params: { "account_id": number; "location_id": number }): Promise<any> {
return this._request("GET", "/api/accounts/{account_id}/locations/{location_id}", { params });
}
}
export default VonageAccountAPI;
No reviews yet. Be the first to rate this API.
Yes. Vonage Account API uses bearer authentication, so you bring your own key from the provider. You store it once on OmniStream and the proxy injects it into every call, so your code only ever sends your Omni key.
The Vonage Business Cloud Account API enables you to retrieve information about accounts. Your application must subscribe to the Provisioning API suite to use this API. It exposes 3 endpoints over GET, including GET /api/accounts/{account_id}, GET /api/accounts/{account_id}/locations, GET /api/accounts/{account_id}/locations/{location_id}.
Install the OmniStream SDK for your language and call Vonage Account API through it. The client is generated from this API's OpenAPI spec, so parameters and responses are fully typed, and the same client also calls every other API in the marketplace.
You can start on the free plan. OmniStream charges for the unified SDK, key storage and proxy rather than for Vonage Account API itself, and Vonage Account API's own rate limits still apply to your provider key.
QuickChart: An API to generate charts and QR codes using QuickChart services.