Wazo Users API

The users API from Wazo — 104 operation(s) for users.

Operations 155

GET /users/me/agents Get agent status of the user holding the authentication token #
POST /users/me/agents/login Log the agent of the user holding the authentication token #
POST /users/me/agents/logoff Logoff the agent of the user holding the authentication token #
POST /users/me/agents/pause Pause the agent of the user holding the authentication token #
POST /users/me/agents/unpause Unpause the agent of the user holding the authentication token #
PUT /users/me/agents/queues/{queue_id}/login Login user agent to queue #
PUT /users/me/agents/queues/{queue_id}/logoff Logoff user agent from queue #
GET /users/{user_uuid}/external/google Get a Google token #
POST /users/{user_uuid}/external/google Ask for a verification URL and store code to get token #
DELETE /users/{user_uuid}/external/google Delete a Google token #
GET /users/{user_uuid}/external/microsoft Get a Microsoft token #
POST /users/{user_uuid}/external/microsoft Ask for a verification URL and store code to get token #
DELETE /users/{user_uuid}/external/microsoft Delete a Microsoft token #
GET /users/{user_uuid}/external/mobile Get device tokens for push notifications #
POST /users/{user_uuid}/external/mobile Configure device tokens for push notifications #
PUT /users/{user_uuid}/external/mobile Update device tokens for push notifications #
DELETE /users/{user_uuid}/external/mobile Delete device tokens for push notifications #
GET /users/{user_uuid}/external/mobile/sender_id Get your Mobile sender_id #
GET /users/{user_uuid}/external Retrieves the list of the users external auth data #
PUT /idp/{idp_type}/users/{user_uuid} Associate user to a IDP #
DELETE /idp/{idp_type}/users/{user_uuid} Dissocuate a user from an IDP #
GET /users/password/reset Reset the user password #
POST /users/password/reset Set the user password #
GET /users/{user_uuid_or_me}/tokens Retrieve a user's refresh token list #
DELETE /users/{user_uuid_or_me}/tokens/{client_id} Delete a user's refresh token #
PUT /admin/users/{user_uuid}/emails Update email addresses #
PUT /users/{user_uuid}/emails Update email addresses #
GET /users/{user_uuid}/emails/{email_uuid}/confirm Ask a new confirmation email #
PUT /groups/{group_uuid}/users/{user_uuid} Associate a group to a user #
DELETE /groups/{group_uuid}/users/{user_uuid} Dissociate a user from a group #
GET /users/{user_uuid}/groups Retrieves the list of groups associated to a user #
GET /users/{user_uuid}/policies Retrieves the list of policies associated to a user #
PUT /users/{user_uuid}/policies/{policy_uuid} Associate a policy to a user #
DELETE /users/{user_uuid}/policies/{policy_uuid} Dissociate a policy from a user #
POST /users/register Create a user #
GET /users/{user_uuid}/sessions Retrieves the list of sessions associated to a user #
DELETE /users/{user_uuid}/sessions/{session_uuid} Delete a session #
GET /users Retrieves the list of users #
POST /users Create a user #
GET /users/{user_uuid} Retrieves the details of a user #
DELETE /users/{user_uuid} Delete a user #
PUT /users/{user_uuid} Update an existing user #
PUT /users/{user_uuid}/password Change the user's password #
GET /users/{user_uuid}/cdr List CDR of the given user #
GET /users/me/cdr List CDR of the authenticated user #
GET /users/me/calls List calls of a user #
POST /users/me/calls Make a new call from a user #
DELETE /users/me/calls/{call_id} Hangup a call from a user #
PUT /users/me/calls/{call_id}/mute/start Mute a call from user #
PUT /users/me/calls/{call_id}/mute/stop Unmute a call from user #
PUT /users/me/calls/{call_id}/hold/start Hold a call from user #
PUT /users/me/calls/{call_id}/hold/stop Unhold a call from user #
PUT /users/me/calls/{call_id}/record/start Start recording a call #
PUT /users/me/calls/{call_id}/record/stop Stop recording a call #
PUT /users/me/calls/{call_id}/record/pause Pause recording a call #
PUT /users/me/calls/{call_id}/record/resume Resume recording a call #
PUT /users/me/calls/{call_id}/answer Answer a call from user #
PUT /users/me/calls/{call_id}/dtmf Simulate a user pressing DTMF keys #
GET /users/me/conferences/{conference_id}/participants List participants of a conference as a user #
GET /users/me/meetings/{meeting_uuid}/participants List participants of a meeting as a user #
DELETE /users/me/meetings/{meeting_uuid}/participants/{participant_id} Kick a participant from a meeting as a user #
PUT /users/me/calls/{call_id}/park Park the user's connected (talking to) call #
GET /users/me/relocates Get the relocates of the authenticated user #
POST /users/me/relocates Initiate a relocate from the authenticated user #
PUT /users/me/relocates/{relocate_uuid}/cancel Cancel a relocate #
PUT /users/me/relocates/{relocate_uuid}/complete Complete a relocate #
GET /users/me/transfers Get the transfers of the authenticated user #
POST /users/me/transfers Initiate a transfer from the authenticated user #
DELETE /users/me/transfers/{transfer_id} Cancel a transfer #
PUT /users/me/transfers/{transfer_id}/complete Complete a transfer #
GET /users/me/voicemails Get details of the voicemail of the authenticated user #
GET /users/me/voicemails/folders/{folder_id} Get details of a folder #
GET /users/me/voicemails/messages Get all user's messages #
GET /users/me/voicemails/messages/{message_id} Get a message #
PUT /users/me/voicemails/messages/{message_id} Update a message #
DELETE /users/me/voicemails/messages/{message_id} Delete a mesage #
GET /users/me/voicemails/messages/{message_id}/recording Get a message's recording #
POST /users/me/voicemails/greetings/{greeting} Create a custom greeting #
HEAD /users/me/voicemails/greetings/{greeting} Check if greeting exists #
GET /users/me/voicemails/greetings/{greeting} Get a custom greeting #
PUT /users/me/voicemails/greetings/{greeting} Update a custom greeting #
DELETE /users/me/voicemails/greetings/{greeting} Delete a custom greeting #
POST /users/me/voicemails/greetings/{greeting}/copy Copy a custom greeting #
PUT /callfilters/{callfilter_id}/recipients/users Update call filter and recipients #
PUT /callfilters/{callfilter_id}/surrogates/users Update call filter and surrogates #
PUT /callpickups/{callpickup_id}/interceptors/users Update call pickup and interceptors #
PUT /callpickups/{callpickup_id}/targets/users Update call pickup and targets #
GET /funckeys/templates/{template_id}/users List users associated to template #
GET /users/{user_id}/funckeys List func keys for a user #
PUT /users/{user_id}/funckeys Update func keys for a user #
GET /users/{user_id}/funckeys/{position} Get a func key for a user #
PUT /users/{user_id}/funckeys/{position} Add/Replace a func key for a user #
DELETE /users/{user_id}/funckeys/{position} Remove func key for user #
GET /users/{user_id}/funckeys/templates List funckey templates associated to user #
PUT /users/{user_id}/funckeys/templates/{template_id} Associate a func key template to a user #
DELETE /users/{user_id}/funckeys/templates/{template_id} Dissociate a func key template to a user #
PUT /groups/{group_uuid}/members/users Update group's user members #
GET /users/me/meetings List user meetings #
POST /users/me/meetings Create user meeting #
GET /users/me/meetings/{meeting_uuid} Get one of the meetings of the current user #
PUT /users/me/meetings/{meeting_uuid} Update one of the meetings of the current user #
DELETE /users/me/meetings/{meeting_uuid} Delete one of the meetings of the current user #
GET /user/me/meetings/{meeting_uuid}/authorizations List all guest authorization requests of a meeting #
PUT /user/me/meetings/{meeting_uuid}/authorizations/{authorization_uuid}/accept Accept a guest authorization request #
PUT /user/me/meetings/{meeting_uuid}/authorizations/{authorization_uuid}/reject Reject a guest authorization request #
PUT /pagings/{paging_id}/callers/users Update paging and callers #
PUT /pagings/{paging_id}/members/users Update paging and members #
PUT /queues/{queue_id}/members/users/{user_id} Update User-Queue association #
DELETE /queues/{queue_id}/members/users/{user_id} Dissociate user and queue #
PUT /switchboards/{switchboard_uuid}/members/users Update switchboard and members #
HEAD /users/{user_id} Check if user exists #
GET /users/{user_id} Get user #
PUT /users/{user_id} Update user #
DELETE /users/{user_id} Delete user #
GET /users/{user_id}/forwards List forwards for a user #
PUT /users/{user_id}/forwards Update all forwards for a user #
GET /users/{user_id}/forwards/{forward_name} Get forward for a user #
PUT /users/{user_id}/forwards/{forward_name} Update a forward for a user #
GET /users/{user_id}/services Get status of all user's services #
PUT /users/{user_id}/services Update all services for a user #
GET /users/{user_id}/services/{service_name} Get status of service #
PUT /users/{user_id}/services/{service_name} Enable/Disable service for a user #
DELETE /users/{user_id}/agents Dissociate user and agent #
PUT /users/{user_id}/agents/{agent_id} Associate user and agent #
PUT /users/{user_id}/callpermissions/{callpermission_id} Associate user and call permission #
DELETE /users/{user_id}/callpermissions/{callpermission_id} Dissociate user and call permission #
GET /users/{user_id}/callerids/outgoing List user's outgoing callerids #
GET /users/{user_uuid}/external/apps List user external apps #
POST /users/{user_uuid}/external/apps/{app_name} Create user external app #
GET /users/{user_uuid}/external/apps/{app_name} Get user external app #
PUT /users/{user_uuid}/external/apps/{app_name} Update user external app #
DELETE /users/{user_uuid}/external/apps/{app_name} Delete user external app #
GET /users/{user_id}/fallbacks List all fallbacks for user #
PUT /users/{user_id}/fallbacks Update user's fallbacks #
PUT /users/{user_id}/groups Update user and groups #
GET /users/export Mass export users and associated resources #
POST /users/import Mass import users and associated resources #
PUT /users/import **Disabled!** Mass import users and associated resources #
DELETE /users/{user_id}/lines/{line_id} Dissociate user and line #
PUT /users/{user_id}/lines/{line_id} Associate user and line #
PUT /users/{user_id}/lines Associate user and lines #
GET /users/{user_uuid}/lines/{line_id}/associated/endpoints/sip Get SIP endpoint of a line for a user #
GET /users/{user_uuid}/lines/main/associated/endpoints/sip Get SIP endpoint of main line for a user #
PUT /users/{user_id}/schedules/{schedule_id} Associate user and schedule #
DELETE /users/{user_id}/schedules/{schedule_id} Dissociate user and schedule #
GET /users/subscriptions Get user subscription #
POST /users/{user_id}/voicemails Create user voicemail #
GET /users/{user_id}/voicemails Get user voicemails #
DELETE /users/{user_id}/voicemails Dissociate user and voicemail #
PUT /users/{user_id}/voicemails/{voicemail_id} Associate user and voicemail #
GET /users/me/subscriptions List subscriptions of a user to HTTP callbacks #
POST /users/me/subscriptions Subscribe to a HTTP callback (webhook) as a user #
GET /users/me/subscriptions/{subscription_uuid} Get a user subscription #
PUT /users/me/subscriptions/{subscription_uuid} Update a user subscription #
DELETE /users/me/subscriptions/{subscription_uuid} Delete a user subscription #

Documentation

Specifications

Other Resources

🔗
Console
https://api.wazo.io/documentation/console/authentication/
🔗
SourceCode
https://github.com/wazo-platform/wazo-auth
🔗
ChangeLog
https://github.com/wazo-platform/wazo-auth/blob/master/CHANGELOG.md
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/conventions/wazo-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/errors/wazo-problem-types.yml
🔗
Console
https://api.wazo.io/documentation/console/configuration/
🔗
SourceCode
https://github.com/wazo-platform/wazo-confd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-confd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/application/
🔗
SourceCode
https://github.com/wazo-platform/wazo-calld
🔗
ChangeLog
https://github.com/wazo-platform/wazo-calld/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/cdr/
🔗
SourceCode
https://github.com/wazo-platform/wazo-call-logd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-call-logd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/contact/
🔗
SourceCode
https://github.com/wazo-platform/wazo-dird
🔗
ChangeLog
https://github.com/wazo-platform/wazo-dird/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/webhook/
🔗
SourceCode
https://github.com/wazo-platform/wazo-webhookd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-webhookd/blob/master/CHANGELOG.md
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-events-webhooks.yml
🔗
Console
https://api.wazo.io/documentation/console/plugins/
🔗
SourceCode
https://github.com/wazo-platform/wazo-plugind
🔗
ChangeLog
https://github.com/wazo-platform/wazo-plugind/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/agent/
🔗
SourceCode
https://github.com/wazo-platform/wazo-agentd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-agentd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/chat/
🔗
SourceCode
https://github.com/wazo-platform/wazo-chatd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-chatd/blob/master/CHANGELOG.md
🔗
SourceCode
https://github.com/wazo-platform/wazo-phoned
🔗
ChangeLog
https://github.com/wazo-platform/wazo-phoned/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/setup/
🔗
SourceCode
https://github.com/wazo-platform/wazo-setupd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-setupd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/amid/
🔗
SourceCode
https://github.com/wazo-platform/wazo-amid
🔗
ChangeLog
https://github.com/wazo-platform/wazo-amid/blob/master/CHANGELOG.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/wazo-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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

OpenAPI Specification

wazo-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Wazo Users API
  contact:
    name: Wazo Dev Team
    url: https://wazo-platform.org/
    email: dev@wazo.community
  x-logo:
    url: https://wazo-platform.org/images/logo-black.svg
    backgroundColor: '#FAFAFA'
    altText: Wazo Logo
  version: '1.0'
  description: 'Operations tagged users across 6 of this provider''s published API definitions: wazo-agentd-api-openapi.yml, wazo-auth-api-openapi.yml, wazo-call-logd-api-openapi.yml, wazo-calld-api-openapi.yml, wazo-confd-api-openapi.yml, wazo-webhookd-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /1.0
- url: /0.1
- url: /1.1
tags:


# --- truncated at 32 KB (248 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/openapi/wazo-users-api-openapi.yml