Wazo

Wazo Forwards API

The forwards API from Wazo — 2 operation(s) for forwards.

Documentation GitHub OpenAPI

Operations 4

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 #

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-forwards-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: wazo-confd Forwards API
  description: Confd exposes an API for managing core resources on a Wazo server such as users, extensions, devices, voicemails, queues, etc.
  version: '1.1'
  license:
    name: GPL v3
    url: http://www.gnu.org/licenses/gpl.txt
  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
servers:
- url: /1.1
security:
- wazo_auth_token: []
tags:
- name: forwards
paths:
  /users/{user_id}/forwards:
    get:
      operationId: list_user_forwards
      summary: List forwards for a user
      description: '**Required ACL:** `confd.users.{user_id}.forwards.read`'
      tags:
      - forwards
      parameters:
      - $ref: '#/components/parameters/useriduuid'
      responses:
        '200':
          description: User-Forwards
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserForwards'
    put:
      operationId: update_user_forwards
      summary: Update all forwards for a user
      description: '**Required ACL:** `confd.users.{user_id}.forwards.update`'
      tags:
      - forwards
      parameters:
      - $ref: '#/components/parameters/useriduuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserForwards'
        required: true
  /users/{user_id}/forwards/{forward_name}:
    get:
      operationId: get_user_forward
      summary: Get forward for a user
      description: '**Required ACL:** `confd.users.{user_id}.forwards.{forward_name}.read`'
      tags:
      - forwards
      parameters:
      - $ref: '#/components/parameters/useriduuid'
      - $ref: '#/components/parameters/forward'
      responses:
        '200':
          description: User-Forward
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserForward'
    put:
      operationId: update_user_forward
      summary: Update a forward for a user
      description: '**Required ACL:** `confd.users.{user_id}.forwards.{forward_name}.update`'
      tags:
      - forwards
      parameters:
      - $ref: '#/components/parameters/useriduuid'
      - $ref: '#/components/parameters/forward'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserForward'
        required: true
components:
  schemas:
    UserForwards:
      title: UserForwards
      properties:
        busy:
          $ref: '#/components/schemas/UserForward'
        noanswer:
          $ref: '#/components/schemas/UserForward'
        unconditional:
          $ref: '#/components/schemas/UserForward'
    Error:
      type: array
      items:
        type: string
    UserForward:
      title: UserForward
      properties:
        enabled:
          type: boolean
        destination:
          type: string
  parameters:
    forward:
      required: true
      name: forward_name
      in: path
      description: the forward name
      schema:
        type: string
        enum:
        - busy
        - noanswer
        - unconditional
    useriduuid:
      required: true
      name: user_id
      in: path
      description: the user's ID or UUID
      schema:
        type: string
  responses:
    ResourceUpdated:
      description: Resource was updated successfully
    UpdateError:
      description: An error occurred when updating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    wazo_auth_token:
      type: apiKey
      name: X-Auth-Token
      in: header
x-xivo-port: 9486
x-xivo-name: confd
x-apievangelist-source:
  harvested_from: https://github.com/wazo-platform/wazo-confd
  assembly: base plugin api.yml deep-merged with all plugin api.yml fragments, reproducing what the running service serves at /api/confd/1.1/api/api.yml (see wazo_confd/plugins/api/http.py — xivo.chain_map.ChainMap)
  spec_version: Swagger 2.0 (as published by Wazo)
  harvested: '2026-08-17'