Vonage

User API

The Vonage Business Cloud User API enables you to retrieve information about users. Your application must subscribe to the Provisioning API suite to use this…

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

The Vonage Business Cloud User API enables you to retrieve information about users.

Your application must subscribe to the Provisioning API suite to use this API.

Endpoints 2

  • GETGet account users data by account ID/api/accounts/:account_id/users?page_size=10&page=10&first_name=John&last_name=Smith&login_name=jsmith&email=john.smith@example.com
  • GETGet user data by account ID and user ID/api/accounts/:account_id/users/:user_id

API details

Base URL
https://api.vonage.com/t/vbc.prod/provisioning
Authentication
A bearer token in the Authorization header
Operations
2 operations on 2 pathsGET 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.11.8
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the User 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 User API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. 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 users data by account ID” (GET /api/accounts/:account_id/users?page_size=10&page=10&first_name=John&last_name=Smith&login_name=jsmith&email=john.smith@example.com), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the User API?

The Vonage Business Cloud User API enables you to retrieve information about users. Your application must subscribe to the Provisioning API suite to use this… It is listed under Other and has 2 endpoints.

Who publishes the User API?

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

What is the base URL of the User API?

Requests go to https://api.vonage.com/t/vbc.prod/provisioning. Endpoint paths are added to this base URL.

How do I authenticate with the User API?

With A bearer token in the Authorization header.

How many endpoints does the User API have?

2 operations on 2 paths (2 GET).

Is forking the User 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.