How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Vonage

Vonage User API

The user API from Vonage — 3 operation(s) for user.

Documentation Provider Profile APIs.io OpenAPI GitHub

Vonage User API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 74 JSON Schema definitions.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.nexmo.com, https://api.nexmo.com/v1.

6 operations 3 paths 24 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.nexmo.com
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Vonage User API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

User 6
GET
/v1/users
List users
getUsers 4 params → 200400401404406429500
POST
/v1/users
Create a user
createUser body → 201400401406429500
GET
/v1/users/{id}
Retrieve a user
getUser 1 param → 200401404406429500
PATCH
/v1/users/{id}
Update a user
updateUser 1 param body → 200400401404406429500
DELETE
/v1/users/{id}
Delete a user
deleteUser 1 param → 204400401404406429500
GET
/users/{user_id}/conversations
List user conversations
getuserConversations 8 params → 200401404500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are conversation_user (9 properties), user_channels (9 properties), user (7 properties), user_lite (4 properties). Each schema is shown below with its type and property counts.

user_name
string
Unique name for a user
user_properties
object
User properties
2 properties
user_links
object
1 property
user_lite
object
4 properties
user
object
7 properties
page_size
number
The amount of records returned in this response
user_id
string
User ID
user_display_name
string
A string to be displayed as user name. It does not need to be unique
user_image_url
string
An image URL that you associate with the user
user_channels
object
9 properties
conversation_members
object
2 properties
conversation_image_url
stringnull
An image URL that you associate with the conversation
conversation_display_name
stringnull
The public facing name of the conversation
conversation_id
string
The unique identifier for this conversation
conversation_links
object
1 property
page_size_2
integer
The amount of records returned in this response
conversation_properties
object
Conversation properties
2 properties
member_id
string
Member ID
conversation_sequence_number
integer
The last Event ID in this conversation. This ID can be used to [retrieve a specific event](getEvent).
conversation_timestamp
object
3 properties
conversation_user
object
9 properties
member_state
string
The state that the member is in. Possible values are INVITED, JOINED, LEFT, or UNKNOWN
conversation_name
string
Your internal conversation name. Must be unique. If not supplied a randomly generated name will be used.
page_size_3
integer
The amount of records returned in this response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-user-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
AE Profile APIs.io
Vonage Advanced API
AE Profile APIs.io
Vonage Application API
AE Profile APIs.io
Vonage Applications API
AE Profile APIs.io
Vonage Archives API
AE Profile APIs.io
Vonage Audio Connector API
AE Profile APIs.io
Vonage Balance API
AE Profile APIs.io
Vonage Basic API
AE Profile APIs.io
Vonage Broadcast API
AE Profile APIs.io
Vonage Calls API
AE Profile APIs.io
Vonage Configuration API
AE Profile APIs.io
Vonage Conversation API
AE Profile APIs.io
#User
← Back to V APIs
API Details
ID
vonage:vonage-user-api
Base URL
https://api.nexmo.com
Docs
https://developer.vonage.com/en/api/sms
Provider
Vonage
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=vonage-user-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/vonage-user-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Vonage User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.