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 Agents API

The agents API from Wazo — 29 operation(s) for agents.

Documentation Provider Profile APIs.io OpenAPI GitHub

Wazo Agents 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 Agents. 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 35 operations across 29 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

35 operations 29 paths 28 schemas 4 DELETE7 GET16 POST8 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
Contact
Wazo Dev Team
License
GPL v3
Resource Areas
1

Authentication & Security 1

Wazo Agents API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (wazo_auth_token). By default, every request must be authenticated.

Paths & Operations 35

Across 29 paths, the API surfaces 35 operations — 4 DELETE, 7 GET, 16 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

agents 35
GET
/agents/by-id/{agent_id}
Get agent status.
get_agent_by_id 2 params → 200404
GET
/agents/by-number/{agent_number}
Get agent status.
get_agent_by_number 2 params → 200404
POST
/agents/by-id/{agent_id}/login
Log an agent.
login_agent_by_id 2 params body → 204400404409
POST
/agents/by-number/{agent_number}/login
Log an agent.
login_agent_by_number 2 params body → 204400404409
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
/agents/by-id/{agent_id}/logoff
Logoff an agent.
logoff_agent_by_id 2 params → 204409
POST
/agents/by-number/{agent_number}/logoff
Logoff an agent.
logoff_agent_by_number 2 params → 204409
POST
/users/me/agents/logoff
Logoff the agent of the user holding the authentication token
logoff_user_agent 1 param → 204400409
POST
/agents/by-number/{agent_number}/pause
Pause an agent.
pause_agent_by_number 2 params body → 204404409
POST
/users/me/agents/pause
Pause the agent of the user holding the authentication token
pause_user_agent 1 param body → 204400409
POST
/agents/by-number/{agent_number}/unpause
Unpause an agent.
unpause_agent_by_number 2 params → 204404409
POST
/users/me/agents/unpause
Unpause the agent of the user holding the authentication token
unpause_user_agent 1 param → 204400409
POST
/agents/by-id/{agent_id}/add
Add agent to a queue.
add_agent_by_id 2 params body → 204400404409
POST
/agents/by-id/{agent_id}/remove
Remove agent from a queue.
remove_agent_by_id 2 params body → 204404409
PUT
/agents/{agent_id}/queues/{queue_id}/login
Login agent to queue
login_agent_to_queue 3 params → 204400404409
PUT
/users/me/agents/queues/{queue_id}/login
Login user agent to queue
user_agent_login_to_queue 2 params → 204400404409
PUT
/agents/{agent_id}/queues/{queue_id}/logoff
Logoff agent from queue
logoff_agent_from_queue 3 params → 204400404409
PUT
/users/me/agents/queues/{queue_id}/logoff
Logoff user agent from queue
user_agent_logoff_from_queue 2 params → 204400404409
GET
/agents
Get the status of all agents.
get_agents 2 params → 200
POST
/agents
Create agent
create_agent 1 param body → 201400
POST
/agents/logoff
Logoff all agents.
logoff_agents 1 param → 204
POST
/agents/relog
Relog all agents.
relog_agents 2 params → 204
GET
/agents/{agent_id}
Get agent
get_agent 2 params → 200404
PUT
/agents/{agent_id}
Update agent
update_agent 2 params body → 204400404
DELETE
/agents/{agent_id}
Delete agent
delete_agent 2 params → 204400404
PUT
/agents/{agent_id}/skills/{skill_id}
Associate agent and skill
associate_agent_skill 3 params body → 204400404
DELETE
/agents/{agent_id}/skills/{skill_id}
Dissociate agent and skill
dissociate_agent_skill 3 params → 204400404
PUT
/queues/{queue_id}/members/agents/{agent_id}
Update Agent-Queue association
update_agent_queue_association 3 params body → 204400404
DELETE
/queues/{queue_id}/members/agents/{agent_id}
Dissociate agent and queue
dissociate_agent_queue 3 params → 204400404
GET
/agents/skills
List skill
list_skills 7 params → 200
POST
/agents/skills
Create skill
create_skill 1 param body → 201400
GET
/agents/skills/{skill_id}
Get skill
get_skill 2 params → 200404
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

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are AgentStatus (11 properties), AgentQueueStatus (6 properties), AgentRelationBase (4 properties), UserRelationBase (3 properties). Each schema is shown below with its type and property counts.

AgentPauseReason
object
1 property
LoginInfo
object
3 properties
AgentStatus
object
11 properties
UserAgentLoginInfo
object
1 property
AgentQueueStatus
object
6 properties
Error
object
1 property
Queue
object
1 property
Skill
SkillRelationAgents
object
1 property
SkillRelationBase
object
3 properties
AgentRelationUser
SkillRelationAgent
AgentSkill
AgentRelationBase
object
4 properties
AgentRelationSkills
object
1 property
AgentRelationQueues
object
1 property
AgentItems
object
2 properties 1 required
QueueMemberAgent
An association between an agent and a queue. Agents associated to a Queue will receive calls when they are logged in.
QueueMemberAgentRelationBase
object
2 properties
QueueRelationBase
object
3 properties
AgentRelationQueue
AgentRelationUsers
object
1 property
AgentSkillRelationBase
object
1 property
AgentRelationSkill
Agent
Error_2
array
SkillItems
object
2 properties 1 required
UserRelationBase
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wazo-agents-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 Applications API
AE Profile APIs.io
Wazo Asterisk API
AE Profile APIs.io
Wazo Backends API
AE Profile APIs.io
Wazo Blocklist API
AE Profile APIs.io
#Agents
← Back to W APIs
API Details
ID
wazo:wazo-agents-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-agents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/wazo-agents-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 Agents 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.