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
Wazo

Wazo Users API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a changelog, authentication docs, and an AsyncAPI specification.

This API exposes 155 operations across 104 paths, and defines 204 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: /1.0, /0.1, /1.1.

155 operations 104 paths 204 schemas 26 DELETE50 GET2 HEAD20 POST57 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{wazo_stack}/api/auth/0.1
Authentication
API Key, HTTP Basic
Contact
Wazo Dev Team
Resource Areas
1

Authentication & Security 2

Wazo Users API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Token (wazo_auth_token). It accepts HTTP basic authentication (wazo_auth_basic).

Paths & Operations 155

Across 104 paths, the API surfaces 155 operations — 26 DELETE, 50 GET, 2 HEAD, 20 POST, 57 PUT. Each is listed below with its method, path, parameters, and response codes.

users 155
GET
/users/me/agents
Get agent status of the user holding the authentication token.
get_user_agent 1 param → 200404
POST
/users/me/agents/login
Log the agent of the user holding the authentication token
login_user_agent 1 param body → 204400409
POST
/users/me/agents/logoff
Logoff the agent of the user holding the authentication token
logoff_user_agent 1 param → 204400409
POST
/users/me/agents/pause
Pause the agent of the user holding the authentication token
pause_user_agent 1 param body → 204400409
POST
/users/me/agents/unpause
Unpause the agent of the user holding the authentication token
unpause_user_agent 1 param → 204400409
PUT
/users/me/agents/queues/{queue_id}/login
Login user agent to queue
user_agent_login_to_queue 2 params → 204400404409
PUT
/users/me/agents/queues/{queue_id}/logoff
Logoff user agent from queue
user_agent_logoff_from_queue 2 params → 204400404409
GET
/users/{user_uuid}/external/google
Get a Google token
1 param → 200401404
POST
/users/{user_uuid}/external/google
Ask for a verification URL and store code to get token
1 param body → 201400
DELETE
/users/{user_uuid}/external/google
Delete a Google token
1 param → 204401404
GET
/users/{user_uuid}/external/microsoft
Get a Microsoft token
1 param → 200401404
POST
/users/{user_uuid}/external/microsoft
Ask for a verification URL and store code to get token
1 param body → 201400
DELETE
/users/{user_uuid}/external/microsoft
Delete a Microsoft token
1 param → 204401404
GET
/users/{user_uuid}/external/mobile
Get device tokens for push notifications
1 param → 200400
POST
/users/{user_uuid}/external/mobile
Configure device tokens for push notifications
1 param body → 200400
PUT
/users/{user_uuid}/external/mobile
Update device tokens for push notifications
1 param body → 200400
DELETE
/users/{user_uuid}/external/mobile
Delete device tokens for push notifications
1 param → 204
GET
/users/{user_uuid}/external/mobile/sender_id
Get your Mobile senderid
1 param → 200400
GET
/users/{user_uuid}/external
Retrieves the list of the users external auth data
6 params → 200
PUT
/idp/{idp_type}/users/{user_uuid}
Associate user to a IDP
addUserIDP 2 params → 204404
DELETE
/idp/{idp_type}/users/{user_uuid}
Dissocuate a user from an IDP
removeIDPUser 2 params → 204404
GET
/users/password/reset
Reset the user password
reset_password 3 params → 204405
POST
/users/password/reset
Set the user password
reset_password_change 1 param body → 204405
GET
/users/{user_uuid_or_me}/tokens
Retrieve a user's refresh token list
listUserRefreshTokens 7 params → 200400401404500
DELETE
/users/{user_uuid_or_me}/tokens/{client_id}
Delete a user's refresh token
deleteRefreshTokens 2 params → 204401404500
PUT
/admin/users/{user_uuid}/emails
Update email addresses
1 param body → 200404
PUT
/users/{user_uuid}/emails
Update email addresses
1 param body → 200404
GET
/users/{user_uuid}/emails/{email_uuid}/confirm
Ask a new confirmation email
2 params → 204404409
PUT
/groups/{group_uuid}/users/{user_uuid}
Associate a group to a user
addUserGroup 2 params → 204404
DELETE
/groups/{group_uuid}/users/{user_uuid}
Dissociate a user from a group
removeUserGroup 2 params → 204404
GET
/users/{user_uuid}/groups
Retrieves the list of groups associated to a user
6 params → 200401404500
GET
/users/{user_uuid}/policies
Retrieves the list of policies associated to a user
6 params → 200401404500
PUT
/users/{user_uuid}/policies/{policy_uuid}
Associate a policy to a user
addUserPolicy 2 params → 204404
DELETE
/users/{user_uuid}/policies/{policy_uuid}
Dissociate a policy from a user
removeUserPolicy 2 params → 204404
POST
/users/register
Create a user
registerUser body → 200400
GET
/users/{user_uuid}/sessions
Retrieves the list of sessions associated to a user
4 params → 200401404500
DELETE
/users/{user_uuid}/sessions/{session_uuid}
Delete a session
user_delete_session 2 params → 204401
GET
/users
Retrieves the list of users
11 params → 200
POST
/users
Create a user
createUser 1 param body → 200400
GET
/users/{user_uuid}
Retrieves the details of a user
1 param → 200401404500
DELETE
/users/{user_uuid}
Delete a user
delete_user 1 param → 204401404500
PUT
/users/{user_uuid}
Update an existing user
updateUser 1 param body → 200400404
PUT
/users/{user_uuid}/password
Change the user's password
1 param body → 204401404405500
GET
/users/{user_uuid}/cdr
List CDR of the given user
18 params → 200400
GET
/users/me/cdr
List CDR of the authenticated user
18 params → 200400
GET
/users/me/calls
List calls of a user
2 params → 200503
POST
/users/me/calls
Make a new call from a user
body → 201400503
DELETE
/users/me/calls/{call_id}
Hangup a call from a user
1 param → 204403404503
PUT
/users/me/calls/{call_id}/mute/start
Mute a call from user
1 param → 204404503
PUT
/users/me/calls/{call_id}/mute/stop
Unmute a call from user
1 param → 204404503
PUT
/users/me/calls/{call_id}/hold/start
Hold a call from user
1 param → 204404503
PUT
/users/me/calls/{call_id}/hold/stop
Unhold a call from user
1 param → 204404503
PUT
/users/me/calls/{call_id}/record/start
Start recording a call
1 param → 204403404503
PUT
/users/me/calls/{call_id}/record/stop
Stop recording a call
1 param → 204403404503
PUT
/users/me/calls/{call_id}/record/pause
Pause recording a call
1 param → 204403404503
PUT
/users/me/calls/{call_id}/record/resume
Resume recording a call
1 param → 204403404503
PUT
/users/me/calls/{call_id}/answer
Answer a call from user
1 param → 204404503
PUT
/users/me/calls/{call_id}/dtmf
Simulate a user pressing DTMF keys
2 params → 204404503
GET
/users/me/conferences/{conference_id}/participants
List participants of a conference as a user
1 param → 200404503
GET
/users/me/meetings/{meeting_uuid}/participants
List participants of a meeting as a user
1 param → 200404503
DELETE
/users/me/meetings/{meeting_uuid}/participants/{participant_id}
Kick a participant from a meeting as a user
2 params → 204404503
PUT
/users/me/calls/{call_id}/park
Park the user's connected (talking to) call
3 params → 200404503
GET
/users/me/relocates
Get the relocates of the authenticated user
→ 200503
POST
/users/me/relocates
Initiate a relocate from the authenticated user
body → 201400403409503
PUT
/users/me/relocates/{relocate_uuid}/cancel
Cancel a relocate
1 param → 204400404503
PUT
/users/me/relocates/{relocate_uuid}/complete
Complete a relocate
1 param → 204400404503
GET
/users/me/transfers
Get the transfers of the authenticated user
→ 200503
POST
/users/me/transfers
Initiate a transfer from the authenticated user
body → 201400403409503
DELETE
/users/me/transfers/{transfer_id}
Cancel a transfer
1 param → 204403404503
PUT
/users/me/transfers/{transfer_id}/complete
Complete a transfer
1 param → 204403404503
GET
/users/me/voicemails
Get details of the voicemail of the authenticated user
→ 200400404503
GET
/users/me/voicemails/folders/{folder_id}
Get details of a folder
1 param → 200400404503
GET
/users/me/voicemails/messages
Get all user's messages
5 params → 200400404503
GET
/users/me/voicemails/messages/{message_id}
Get a message
1 param → 200400404503
PUT
/users/me/voicemails/messages/{message_id}
Update a message
1 param body → 204400404503
DELETE
/users/me/voicemails/messages/{message_id}
Delete a mesage
1 param → 204400404503
GET
/users/me/voicemails/messages/{message_id}/recording
Get a message's recording
3 params → 200400404503
POST
/users/me/voicemails/greetings/{greeting}
Create a custom greeting
1 param body → 204400404503
HEAD
/users/me/voicemails/greetings/{greeting}
Check if greeting exists
1 param → 200400404503
GET
/users/me/voicemails/greetings/{greeting}
Get a custom greeting
1 param → 200400404503
PUT
/users/me/voicemails/greetings/{greeting}
Update a custom greeting
1 param body → 204400404503
DELETE
/users/me/voicemails/greetings/{greeting}
Delete a custom greeting
1 param → 204400404503
POST
/users/me/voicemails/greetings/{greeting}/copy
Copy a custom greeting
1 param body → 204400404503
PUT
/callfilters/{callfilter_id}/recipients/users
Update call filter and recipients
update_call_filter_caller_users 1 param body → 204400404
PUT
/callfilters/{callfilter_id}/surrogates/users
Update call filter and surrogates
update_call_filter_member_users 1 param body → 204400404
PUT
/callpickups/{callpickup_id}/interceptors/users
Update call pickup and interceptors
update_call_pickup_interceptor_users 2 params body → 204400404
PUT
/callpickups/{callpickup_id}/targets/users
Update call pickup and targets
update_call_pickup_target_users 2 params body → 204400404
GET
/funckeys/templates/{template_id}/users
List users associated to template
list_func_key_template_user_associations 2 params → 200404
GET
/users/{user_id}/funckeys
List func keys for a user
list_user_func_keys 2 params → 200
PUT
/users/{user_id}/funckeys
Update func keys for a user
update_user_func_keys 2 params body → 204400
GET
/users/{user_id}/funckeys/{position}
Get a func key for a user
get_user_func_key 3 params → 200404
PUT
/users/{user_id}/funckeys/{position}
Add/Replace a func key for a user
update_user_func_key 3 params body → 204400
DELETE
/users/{user_id}/funckeys/{position}
Remove func key for user
delete_user_func_key 3 params → 204400404
GET
/users/{user_id}/funckeys/templates
List funckey templates associated to user
list_user_func_key_template_associations 2 params → 200404
PUT
/users/{user_id}/funckeys/templates/{template_id}
Associate a func key template to a user
associate_user_func_key_template 3 params → 204400404
DELETE
/users/{user_id}/funckeys/templates/{template_id}
Dissociate a func key template to a user
dissociate_user_func_key_template 3 params → 204400404
PUT
/groups/{group_uuid}/members/users
Update group's user members
update_group_member_users 1 param body → 204400404
GET
/users/me/meetings
List user meetings
list_user_meetings 7 params → 200
POST
/users/me/meetings
Create user meeting
create_user_meeting 1 param body → 201400
GET
/users/me/meetings/{meeting_uuid}
Get one of the meetings of the current user
get_user_meeting 2 params → 200404
PUT
/users/me/meetings/{meeting_uuid}
Update one of the meetings of the current user
update_user_meeting 2 params body → 204400404
DELETE
/users/me/meetings/{meeting_uuid}
Delete one of the meetings of the current user
delete_user_meeting 2 params → 204400404
GET
/user/me/meetings/{meeting_uuid}/authorizations
List all guest authorization requests of a meeting
list_user_meeting_authorizations 1 param → 200404
PUT
/user/me/meetings/{meeting_uuid}/authorizations/{authorization_uuid}/accept
Accept a guest authorization request
put_user_meeting_authorization_accept 2 params → 200400404
PUT
/user/me/meetings/{meeting_uuid}/authorizations/{authorization_uuid}/reject
Reject a guest authorization request
put_user_meeting_authorization_reject 2 params → 200400404
PUT
/pagings/{paging_id}/callers/users
Update paging and callers
update_paging_caller_users 1 param body → 204400404
PUT
/pagings/{paging_id}/members/users
Update paging and members
update_paging_member_users 1 param body → 204400404
PUT
/queues/{queue_id}/members/users/{user_id}
Update User-Queue association
update_user_queue_association 3 params body → 204400404
DELETE
/queues/{queue_id}/members/users/{user_id}
Dissociate user and queue
dissociate_user_queue 3 params → 204400404
PUT
/switchboards/{switchboard_uuid}/members/users
Update switchboard and members
update_switchboard_member_users 1 param body → 204400404
HEAD
/users/{user_id}
Check if user exists
head_user 2 params → 200404
GET
/users/{user_id}
Get user
get_user 2 params → 200404
PUT
/users/{user_id}
Update user
update_user 2 params body → 204400404
DELETE
/users/{user_id}
Delete user
delete_user 3 params → 204400404
GET
/users/{user_id}/forwards
List forwards for a user
list_user_forwards 1 param → 200
PUT
/users/{user_id}/forwards
Update all forwards for a user
update_user_forwards 1 param body → 204400
GET
/users/{user_id}/forwards/{forward_name}
Get forward for a user
get_user_forward 2 params → 200
PUT
/users/{user_id}/forwards/{forward_name}
Update a forward for a user
update_user_forward 2 params body → 204400
GET
/users/{user_id}/services
Get status of all user's services
get_user_services 1 param → 200404
PUT
/users/{user_id}/services
Update all services for a user
update_user_services 1 param body → 204400
GET
/users/{user_id}/services/{service_name}
Get status of service
get_user_service 2 params → 200404
PUT
/users/{user_id}/services/{service_name}
Enable/Disable service for a user
update_user_service 2 params body → 204400
DELETE
/users/{user_id}/agents
Dissociate user and agent
dissociate_user_agent 2 params → 204400404
PUT
/users/{user_id}/agents/{agent_id}
Associate user and agent
associate_user_agent 3 params → 204400404
PUT
/users/{user_id}/callpermissions/{callpermission_id}
Associate user and call permission
associate_user_callpermission 3 params → 400404
DELETE
/users/{user_id}/callpermissions/{callpermission_id}
Dissociate user and call permission
dissociate_user_callpermission 3 params → 204400404
GET
/users/{user_id}/callerids/outgoing
List user's outgoing callerids
list_user_callerid_outgoing 2 params → 200
GET
/users/{user_uuid}/external/apps
List user external apps
list_user_external_apps 8 params → 200
POST
/users/{user_uuid}/external/apps/{app_name}
Create user external app
create_user_external_app 3 params body → 201400
GET
/users/{user_uuid}/external/apps/{app_name}
Get user external app
get_user_external_app 4 params → 200404
PUT
/users/{user_uuid}/external/apps/{app_name}
Update user external app
update_user_external_app 3 params body → 204400404
DELETE
/users/{user_uuid}/external/apps/{app_name}
Delete user external app
delete_user_external_app 3 params → 204400404
GET
/users/{user_id}/fallbacks
List all fallbacks for user
get_user_fallback 1 param → 200
PUT
/users/{user_id}/fallbacks
Update user's fallbacks
update_user_fallback 1 param body → 204400404
PUT
/users/{user_id}/groups
Update user and groups
update_user_groups 1 param body → 204400404
GET
/users/export
Mass export users and associated resources
export_users_csv 1 param → 200
POST
/users/import
Mass import users and associated resources
import_users_csv 2 params → 201400
PUT
/users/import
Disabled! Mass import users and associated resources
update_users_csv 2 params → 200400405
DELETE
/users/{user_id}/lines/{line_id}
Dissociate user and line
dissociate_user_line 2 params → 204400404
PUT
/users/{user_id}/lines/{line_id}
Associate user and line
associate_user_line 2 params → 204400404
PUT
/users/{user_id}/lines
Associate user and lines
associate_user_lines 1 param body → 204400404
GET
/users/{user_uuid}/lines/{line_id}/associated/endpoints/sip
Get SIP endpoint of a line for a user
get_user_line_associated_endpoints_sip 3 params → 200400
GET
/users/{user_uuid}/lines/main/associated/endpoints/sip
Get SIP endpoint of main line for a user
get_user_line_main_associated_endpoints_sip 2 params → 200400
PUT
/users/{user_id}/schedules/{schedule_id}
Associate user and schedule
associate_user_schedule 3 params → 204400404
DELETE
/users/{user_id}/schedules/{schedule_id}
Dissociate user and schedule
dissociate_user_schedule 3 params → 204400404
GET
/users/subscriptions
Get user subscription
get_users_subscriptions 1 param → 200
POST
/users/{user_id}/voicemails
Create user voicemail
create_user_voicemail 2 params body → 201400404
GET
/users/{user_id}/voicemails
Get user voicemails
get_user_voicemail 2 params → 200404
DELETE
/users/{user_id}/voicemails
Dissociate user and voicemail
dissociate_user_voicemail 1 param → 204400404
PUT
/users/{user_id}/voicemails/{voicemail_id}
Associate user and voicemail
associate_user_voicemail 2 params → 204400404
GET
/users/me/subscriptions
List subscriptions of a user to HTTP callbacks
list_user_subscriptions 1 param → 200401503
POST
/users/me/subscriptions
Subscribe to a HTTP callback (webhook) as a user
create_user_subscription 1 param → 201400401503
GET
/users/me/subscriptions/{subscription_uuid}
Get a user subscription
get_user_subscription 1 param → 200404401503
PUT
/users/me/subscriptions/{subscription_uuid}
Update a user subscription
update_user_subscription 2 params → 200404401503
DELETE
/users/me/subscriptions/{subscription_uuid}
Delete a user subscription
delete_user_subscription 1 param → 204401404503

Schemas 204

The contract defines 204 schemas that model the data the API accepts and returns. The most detailed are UserPost (40 properties), CDR (37 properties), Call (23 properties), BaseVoicemail (15 properties). Each schema is shown below with its type and property counts.

AgentPauseReason
object
1 property
AgentStatus
object
11 properties
UserAgentLoginInfo
object
1 property
AgentQueueStatus
object
6 properties
Error
object
1 property
UserEmailList
object
1 property
APIError
object
4 properties
GoogleGetResult
object
3 properties 3 required
UserRegister
object
5 properties 3 required
ExternalAuth
object
4 properties
MicrosoftPost
object
1 property
SessionResult
object
4 properties
ExternalAuthList
object
3 properties 3 required
UserEmail
object
3 properties
UserBase
object
6 properties
GetSessionsResult
object
3 properties 3 required
RefreshToken
object
6 properties
UserList
object
3 properties
UserCreate
MobileData
object
6 properties
UserEdit
MicrosoftPostResult
object
1 property 1 required
UserPostResponse
object
5 properties
GooglePostResult
object
1 property 1 required
AdminUserEmailList
object
1 property
GetGroupsResult
object
3 properties 3 required
UserResult
object
8 properties
GooglePost
object
1 property
Policy
object
5 properties 1 required
GetPoliciesResult
object
2 properties 2 required
GroupResult
object
6 properties
MicrosoftGetResult
object
3 properties 3 required
PolicyResult
object
PostPasswordReset
object
1 property 1 required
PasswordChange
object
2 properties 2 required
Error_2
object
3 properties
RefreshTokenList
object
3 properties
Recording
object
5 properties
CDRList
object
3 properties
call_status
string
CDR
object
37 properties
Error_3
object
Error message for the client
4 properties
Timeout
integer
Number of seconds to wait for the recipient to answer
Transfer
object
8 properties
UserRelocateRequest
object
6 properties 2 required
UserRelocateLocation
object
1 property
VoicemailFolderBase
object
3 properties
GreetingCopy
object
1 property 1 required
TransferFlow
string
Behavior of the transfer. attended allows the initiator to talk to the recipient. blind does not.
UserTransferRequest
object
4 properties 2 required
VoicemailMessageVoicemail
object
3 properties
Relocate
object
6 properties
RelocateCompletions
array
TransferList
object
1 property
Call
object
23 properties
LocationLine
object
2 properties 1 required
TalkingTo
object
1 property
VoicemailFolder
object
Participant
object
9 properties
VoicemailMessageBase
object
6 properties
VoicemailMessages
object
2 properties
ParkCallBody
object
3 properties 1 required
VoicemailTranscriptedMessageBase
object
RelocateCompletion
string
VoicemailTranscription
object
1 property
VoicemailMessageUpdate
object
1 property 1 required
Voicemail
object
5 properties
ParticipantList
object
1 property
RelocateList
object
1 property
Error_4
object
Error message for the client
4 properties
VoicemailMessage
object
UserCallRequest
object
6 properties 1 required
ParkedCallInfo
object
Information returned when a call has been parked
2 properties
TransferTimeout
integer
Maximum ringing time before cancelling the transfer (in seconds). Default (or null) is an unlimited ring time.
LineEndpointSIP
object
1 property
SIPAuthSectionOptions
UserImportError
object
List of errors that occurred during import
1 property
BaseVoicemail
object
15 properties 3 required
DestinationConference
object
2 properties 2 required
MeetingItems
object
1 property
BaseUser
UserUuid
object
1 property
DestinationCustom
object
2 properties 2 required
UserRelationIncalls
object
1 property
UserFuncKeyTemplate
object
Association between a User and a FuncKey Template
2 properties
DestinationIVR
object
2 properties 2 required
LineEndpointCustom
object
1 property
DestinationApplicationApplication
object
6 properties
UserSubscription
object
2 properties
EndpointSccp
GroupRelationBase
object
3 properties
UserGroupsID
object
1 property
EndpointRelationTrunk
object
1 property
UserRelationBase
object
3 properties
UserRelationVoicemail
object
1 property
LineRelationBase
object
2 properties
SIPIdentifySectionOptions
DestinationExtension
object
3 properties 3 required
SIPTransportRelation
object
1 property 1 required
EndpointSIP
object
14 properties
UserCallerID
object
3 properties
UserPost
object
40 properties
UserRelationQueues
object
1 property
VoicemailItems
object
2 properties
UserRelationIncall
DestinationGroup
object
3 properties 2 required
AgentRelationBase
object
4 properties
DestinationHangupNormal
1 required
UserRelationCallPickupTargets
object
1 property
UserItems
object
2 properties 1 required
UserImport
object
List of users successfully imported
1 property
UserSubscriptionItems
object
2 properties 1 required
DestinationApplication
object
1 property 1 required
UserRelationFallbacks
object
1 property
UserPostResponse_2
EndpointSipRelationBase
object
4 properties
Meeting
object
9 properties
DestinationHangupCongestion
1 required
DestinationApplicationCustom
2 required
SIPAORSectionOptions
EndpointCustom
CallFilterRecipientUsersUuid
object
1 property
UserRelationAgent
object
1 property
DestinationApplicationCallbackDISA
DestinationApplicationFaxToMail
2 required
UserRelationLines
object
1 property
IncallRelationBase
object
1 property
DestinationNone
object
1 property 1 required
MeetingAuthorization
object
5 properties
MeetingRequest
object
UserFallbacks
object
4 properties
LineRelationEndpoints
object
3 properties
EndpointRelationLine
object
1 property
GroupMemberUsers
object
1 property 1 required
QueueMemberUserRelationBase
object
1 property
UserForwards
object
3 properties
DestinationUser
object
4 properties 2 required
UserPostRelationIncalls
object
1 property
DestinationHangup
object
1 property 1 required
DestinationQueue
object
5 properties 2 required
UserRelationForwards
object
1 property
FuncKeyTemplate
object
Further documentation at https://wazo-platform.org/uc-doc/administration/users/csvimport
4 properties
EndpointSccpRelationBase
object
1 property
UserService
object
1 property 1 required
LineID
object
1 property
DestinationHangupBusy
1 required
DestinationHangupCause
object
3 properties
IncallRelationExtensions
object
1 property
FuncKey
object
Further documentation at https://wazo-platform.org/uc-doc/apisdk/restapi/confd/funckeys
3 properties
EndpointSIPTemplatesRelation
object
2 properties 1 required
SwitchboardRelationBase
object
2 properties
UserForward
object
2 properties
DestinationSound
object
4 properties 2 required
TrunkRelationBase
object
2 properties
DestinationVoicemail
object
4 properties 2 required
SIPEndpointSectionOptions
LinesID
object
1 property
Voicemail_2
MeetingAuthorizationItems
object
2 properties
Error_5
array
AuthUserPost
object
1 property
QueueMemberUser
An association between a user and a queue.
DestinationApplicationDISA
DestinationApplicationDirectory
DestinationOutcall
object
3 properties 3 required
UserCallerIDItems
object
2 properties 1 required
LineRelationExtensions
object
1 property
UserRelationSwitchboards
object
1 property
DestinationApplicationVoicemail
KeyValueOption
array
Options must have the following form: { "options": [ ["option", "value"], ] }
UserExport
string
LineEndpointSCCP
object
1 property
UserUpdate
object
List of users successfully updated
1 property
GroupMemberUser
object
2 properties 1 required
DestinationType
object
14 properties
UserRelationServices
object
1 property
UserGroupID
object
2 properties
UserRelationLine
UserPostRelationLine
object
1 property
QueueRelationBase
object
3 properties
CallFilterRecipientUserUuid
EndpointCustomRelationBase
object
2 properties
Line
object
7 properties 1 required
ExtensionRelationBase
object
3 properties
UserRelationGroups
object
1 property
UsersUuid
object
1 property
LineExtensions
object
1 property
VoicemailRelationUsers
object
1 property
UserExternalApp
object
3 properties
DestinationSwitchboard
object
2 properties 2 required
SIPRegistrationSectionOptions
UserExternalAppItems
object
2 properties 1 required
User
VoicemailRelationBase
object
2 properties
UserServices
object
2 properties
MeetingUserRequest
object
2 properties
ServiceConfig
object
HTTPServiceConfig
object
5 properties 2 required
SubscriptionList
object
2 properties
UserSubscriptionRequest
object
5 properties 4 required
SubscriptionRequest
object
7 properties 4 required
SubscriptionMetadata
object
Arbitrary key-value storage for this subscription. May be used to tag subscriptions. PUT replaces all metadata.
Error_6
object
Error message for the client
4 properties
Subscription
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wazo-users-api-openapi.yml Raw ↑

Other APIs Wazo publishes across the network.

Wazo Phone Provisioning API (wazo-provd)
AE Profile APIs.io
Wazo Websocket Event Stream (wazo-websocketd)
AE Profile APIs.io
Wazo Aastra API
AE Profile APIs.io
Wazo Access Features API
AE Profile APIs.io
Wazo Action API
AE Profile APIs.io
Wazo Adhoc Conferences API
AE Profile APIs.io
Wazo Admin API
AE Profile APIs.io
Wazo Agent Statistics API
AE Profile APIs.io
Wazo Agents API
AE Profile APIs.io
Wazo Applications API
AE Profile APIs.io
Wazo Asterisk API
AE Profile APIs.io
Wazo Backends API
AE Profile APIs.io
#User
← Back to W APIs
API Details
ID
wazo:wazo-users-api
Base URL
https://{wazo_stack}/api/auth/0.1
Docs
https://api.wazo.io/documentation/api/authentication.html
Provider
Wazo
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=wazo-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/wazo-users-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 Wazo Users 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.