Wazo Groups API

The groups API from Wazo — 15 operation(s) for groups.

Operations 24

GET /groups/{group_uuid}/policies Retrieves the list of policies associated to a group
PUT /groups/{group_uuid}/policies/{policy_uuid} Associate a group to a policy #
DELETE /groups/{group_uuid}/policies/{policy_uuid} Dissociate a policy from a group #
GET /groups List groups #
POST /groups Create a new group #
GET /groups/{group_uuid} Retrieves the details of a group
DELETE /groups/{group_uuid} Delete a group #
PUT /groups/{group_uuid} Modify a group #
GET /groups/{group_uuid}/users Retrieves the list of users associated to a group
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 #
PUT /callpickups/{callpickup_id}/interceptors/groups Update call pickup and interceptors #
PUT /callpickups/{callpickup_id}/targets/groups Update call pickup and targets #
PUT /groups/{group_uuid}/callpermissions/{callpermission_id} Associate group and call permission #
DELETE /groups/{group_uuid}/callpermissions/{callpermission_id} Dissociate group and call permission #
PUT /groups/{group_uuid}/extensions/{extension_id} Associate group and extension #
DELETE /groups/{group_uuid}/extensions/{extension_id} Dissociate group and extension #
GET /groups/{group_uuid}/fallbacks List all fallbacks for group #
PUT /groups/{group_uuid}/fallbacks Update group's fallbacks #
PUT /groups/{group_uuid}/members/users Update group's user members #
PUT /groups/{group_uuid}/members/extensions update group's extension members #
PUT /groups/{group_uuid}/schedules/{schedule_id} Associate group and schedule #
DELETE /groups/{group_uuid}/schedules/{schedule_id} Dissociate group and schedule #
PUT /users/{user_id}/groups Update user and groups #

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-groups-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-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Wazo Groups 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 groups across 2 of this provider''s published API definitions: wazo-auth-api-openapi.yml, wazo-confd-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /0.1
- url: /1.1
tags:
- name: groups
paths:
  /groups/{group_uuid}/policies:
    get:
      tags:
      - groups
      security:
      - wazo_auth_token: []
      description: '**Required ACL**: `auth.groups.{group_uuid}.policies.read`'
      parameters:
      - $ref: '#/components/parameters/group_uuid'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      summary: Retrieves the list of policies associated to a group
      responses:
        '200':
          description: The group's policies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPoliciesResult'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Policy not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: System related error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: /0.1
  /groups/{group_uuid}/policies/{policy_uuid}:
    put:
      tags:
      - groups
      security:
      - wazo_auth_token: []
      operationId: addGroupPolicy
      description: '**Required ACL:** `auth.groups.{group_uuid}.policies.{policy_uuid}.create`'
      summary: Associate a group to a policy
      parameters:
      - $ref: '#/components/parameters/group_uuid'
      - $ref: '#/components/parameters/policy_uuid'
      responses:
        '204':
          description: The policy has been assigned
        '404':
          description: Policy or Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
      - groups
      security:
      - wazo_auth_token: []
      operationId: removeGroupPolicy
      description: '**Required ACL:** `auth.groups.{group_uuid}.policies.{policy_uuid}.delete`'
      summary: Dissociate a policy from a group
      parameters:
      - $ref: '#/components/parameters/group_uuid'
      - $ref: '#/components/parameters/policy_uuid'
      responses:
        '204':
          description: The policy has been unassigned
        '404':
          description: Policy or Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: /0.1
  /groups:
    get:
      security:
      - wazo_auth_token: []
      summary: List groups
      description: '**Required ACL:** `auth.groups.read`'
      operationId: listGroups
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/recurse'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/search_uuid'
      - $ref: '#/components/parameters/search_name'
      - $ref: '#/components/parameters/search_user_uuid'
      - $ref: '#/components/parameters/search_read_only'
      - $ref: '#/components/parameters/search_policy_slug'
      - $ref: '#/components/parameters/search_policy_uuid'
      responses:
        '200':
          description: A list of group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupsResult'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      security:
      - wazo_auth_token: []
      summary: Create a new group
      description: '**Required ACL:** `auth.groups.create`'
      operationId: createGroups
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      responses:
        '200':
          description: The created group's data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResult'
        '401':
          description: Invalid data has been supplied'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Duplicate Group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
        description: The group creation parameters
        required: true
    servers:
    - url: /0.1
  /groups/{group_uuid}:
    get:
      tags:
      - groups
      security:
      - wazo_auth_token: []
      description: '**Required ACL**: `auth.groups.{group_uuid}.read'
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/group_uuid'
      summary: Retrieves the details of a group
      responses:
        '200':
          description: The group's data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResult'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: System related error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: delete_group
      tags:
      - groups
      security:
      - wazo_auth_token: []
      description: '**Required ACL**: `auth.groups.{group_uuid}.delete`'
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/group_uuid'
      summary: Delete a group
      responses:
        '204':
          description: The group has been removed
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: System related error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    put:
      security:
      - wazo_auth_token: []
      summary: Modify a group
      description: '**Required ACL:** `auth.groups.{group_uuid}.update`'
      operationId: editGroups
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/group_uuid'
      responses:
        '200':
          description: The modified group's data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupResult'
        '401':
          description: Invalid data has been supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Duplicate Group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupPut'
        description: The group parameters
        required: true
    servers:
    - url: /0.1
  /groups/{group_uuid}/users:
    get:
      tags:
      - groups
      security:
      - wazo_auth_token: []
      description: '**Required ACL**: `auth.groups.{group_uuid}.users.read`'
      parameters:
      - $ref: '#/components/parameters/group_uuid'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      summary: Retrieves the list of users associated to a group
      responses:
        '200':
          description: The group's users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: System related error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: /0.1
  /groups/{group_uuid}/users/{user_uuid}:
    put:
      tags:
      - groups
      security:
      - wazo_auth_token: []
      operationId: addUserGroup
      description: '**Required ACL:** `auth.groups.{group_uuid}.users.{user_uuid}.create`'
      summary: Associate a group to a user
      parameters:
      - $ref: '#/components/parameters/group_uuid'
      - $ref: '#/components/parameters/user_uuid'
      responses:
        '204':
          description: The user has been assigned
        '404':
          description: User or Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
      - groups
      security:
      - wazo_auth_token: []
      operationId: removeUserGroup
      description: '**Required ACL:** `auth.groups.{group_uuid}.users.{user_uuid}.delete`'
      summary: Dissociate a user from a group
      parameters:
      - $ref: '#/components/parameters/group_uuid'
      - $ref: '#/components/parameters/user_uuid'
      responses:
        '204':
          description: The user has been unassigned
        '404':
          description: User or Group not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: /0.1
  /callpickups/{callpickup_id}/interceptors/groups:
    put:
      operationId: update_call_pickup_interceptor_groups
      summary: Update call pickup and interceptors
      description: '**Required ACL:** `confd.callpickups.{callpickup_id}.interceptors.groups.update`


        **WARNING**

        This endpoint remove all interceptors which are not defined.

        '
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/callpickupid'
      responses:
        '204':
          description: Call Pickup and Groups associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupsID'
        description: Groups to associated
        required: true
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /callpickups/{callpickup_id}/targets/groups:
    put:
      operationId: update_call_pickup_target_groups
      summary: Update call pickup and targets
      description: '**Required ACL:** `confd.callpickups.{callpickup_id}.targets.groups.update`


        **WARNING**

        This endpoint remove all targets which are not defined.

        '
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/callpickupid'
      responses:
        '204':
          description: Call Pickup and Groups associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupsID'
        description: Groups to associated
        required: true
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /groups/{group_uuid}/callpermissions/{callpermission_id}:
    put:
      operationId: associate_group_callpermission
      summary: Associate group and call permission
      description: '**Required ACL:** `confd.groups.{group_uuid}.callpermissions.{call_permission_id}.update`'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/groupuuid'
      - $ref: '#/components/parameters/callpermissionid'
      responses:
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - wazo_auth_token: []
    delete:
      operationId: dissociate_group_callpermission
      summary: Dissociate group and call permission
      description: '**Required ACL:** `confd.groups.{group_uuid}.callpermissions.{call_permission_id}.delete`'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/groupuuid'
      - $ref: '#/components/parameters/callpermissionid'
      responses:
        '204':
          description: Group and Call Permission dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /groups/{group_uuid}/extensions/{extension_id}:
    put:
      operationId: associate_group_extension
      summary: Associate group and extension
      description: '**Required ACL:** `confd.groups.{group_uuid}.extensions.{extension_id}.update`'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/groupuuid'
      - $ref: '#/components/parameters/extensionid'
      responses:
        '204':
          description: Group and Extension associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - wazo_auth_token: []
    delete:
      operationId: dissociate_group_extension
      summary: Dissociate group and extension
      description: '**Required ACL:** `confd.groups.{group_uuid}.extensions.{extension_id}.delete`'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/groupuuid'
      - $ref: '#/components/parameters/extensionid'
      responses:
        '204':
          description: Group and Extension dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /groups/{group_uuid}/fallbacks:
    get:
      operationId: get_group_fallback
      summary: List all fallbacks for group
      description: '**Required ACL:** `confd.groups.{group_uuid}.fallbacks.read`'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/groupuuid'
      responses:
        '200':
          description: Fallbacks for group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupFallbacks'
      security:
      - wazo_auth_token: []
    put:
      operationId: update_group_fallback
      summary: Update group's fallbacks
      description: '**Required ACL:** `confd.groups.{group_uuid}.fallbacks.update`


        **WARNING** This endpoint delete all fields that are not defined.'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/groupuuid'
      responses:
        '204':
          description: Group's fallbacks updated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupFallbacks'
        description: Fallbacks for group
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /groups/{group_uuid}/members/users:
    put:
      operationId: update_group_member_users
      summary: Update group's user members
      description: '**Required ACL:** `confd.groups.{group_uuid}.members.users.update`


        user members are called by ringing all of the user''s configured lines simultaneously;

        user redirections are not used;


        **WARNING**

        This endpoint remove all members which are not defined.

        '
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/groupuuid'
      responses:
        '204':
          description: Group and Users associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupMemberUsers'
        description: Users to associated
        required: true
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /groups/{group_uuid}/members/extensions:
    put:
      operationId: update_group_member_extensions
      summary: update group's extension members
      description: '**Required ACL:** `confd.groups.{group_uuid}.members.extensions.update`


        a call to an extension member directly invokes the complete dialplan logic of that extension,

        as if the extension was called directly;


        **WARNING**

        This endpoint remove all members which are not defined.

        '
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/groupuuid'
      responses:
        '204':
          description: Group and Extensions associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupMemberExtensions'
        description: Extensions to associated
        required: true
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /groups/{group_uuid}/schedules/{schedule_id}:
    put:
      operationId: associate_group_schedule
      summary: Associate group and schedule
      description: '**Required ACL:** `confd.groups.{group_uuid}.schedules.{schedule_id}.update`'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/groupuuid'
      - $ref: '#/components/parameters/scheduleid'
      responses:
        '204':
          description: Group and Schedule associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - wazo_auth_token: []
    delete:
      operationId: dissociate_group_schedule
      summary: Dissociate group and schedule
      description: '**Required ACL:** `confd.groups.{group_uuid}.schedules.{schedule_id}.delete`'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/groupuuid'
      - $ref: '#/components/parameters/scheduleid'
      responses:
        '204':
          description: Group and Schedule dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
  /users/{user_id}/groups:
    put:
      operationId: update_user_groups
      summary: Update user and groups
      description: '**Required ACL:** `confd.users.{user_id}.groups`

        **WARNING** This endpoint remove all groups which are not defined.'
      tags:
      - groups
      parameters:
      - $ref: '#/components/parameters/useriduuid'
      responses:
        '204':
          description: Group and Users associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupsID'
        description: Users to associated
        required: true
      security:
      - wazo_auth_token: []
    servers:
    - url: /1.1
components:
  parameters:
    tenantuuid:
      name: Wazo-Tenant
      in: header
      description: The tenant's UUID, defining the ownership of a given resource.
      required: false
      schema:
        type: string
    search_name:
      name: name
      in: query
      description: The name of the group
      required: false
      schema:
        type: string
    search_uuid:
      name: uuid
      in: query
      description: The UUID of the group
      required: false
      schema:
        type: string
    offset:
      name: offset
      in: query
      description: The offset defines the offsets the start by the number specified
      required: false
      schema:
        type: integer
        default: 0
    group_uuid:
      name: group_uuid
      in: path
      description: The UUID of the group
      required: true
      schema:
        type: string
    order:
      required: false
      name: order
      in: query
      description: Name of the field to use for sorting the list of items returned.
      schema:
        type: string
    search_policy_uuid:
      name: policy_uuid
      in: query
      description: The UUID of the policy that the group must have.
      schema:
        type: string
    search_user_uuid:
      name: user_uuid
      in: query
      description: The UUID of the user
      required: false
      schema:
        type: string
    user_uuid:
      name: user_uuid
      in: path
      description: The UUID of the user
      required: true
      schema:
        type: string
    direction:
      required: false
      name: direction
      in: query
      description: Sort list of items in 'asc' (ascending) or 'desc' (descending) order
      schema:
        type: string
        enum:
        - asc
        - desc
    recurse:
      name: recurse
      in: query
      description: Should the query include sub-tenants
      required: false
      schema:
        type: boolean
        default: false
    search_read_only:
      name: read_only
      in: query
      description: Is the group managed by the system?
      required: false
      schema:
        type: string
    search:
      required: false
      name: search
      in: query
      description: Search term for filtering a list of items. Only items with a field containing the search term will be returned.
      schema:
        type: string
    policy_uuid:
      name: policy_uuid
      in: path
      description: The UUID or slug of the policy. The slug is unique within a tenant, hence the tenant must be specified.
      required: true
      schema:
        type: string
    search_policy_slug:
      name: policy_slug
      in: query
      description: The slug of the policy that the group must have.
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: The limit defines the number of individual objects that are returned
      required: false
      schema:
        type: integer
    groupuuid:
      required: true
      name: group_uuid
      in: path
      description: the group's UUID
      schema:
        type: string
    useriduuid:
      required: true
      name: user_id
      in: path
      description: the user's ID or UUID
      schema:
        type: string
    callpickupid:
      required: true
      name: callpickup_id
      in: path
      description: Call Pickup's ID
      schema:
        type: integer
    offset_2:
      required: false
      name: offset
      in: query
      description: Number of items to skip over in the list. Useful for pagination.
      schema:
        type: integer
    extensionid:
      required: true
      name: extension_id
      in: path
      schema:
        type: integer
    scheduleid:
      required: true
      name: schedule_id
      in: path
      description: Schedule's ID
      schema:
        type: integer
    callpermissionid:
      required: true
      name: callpermission_id
      in: path
      description: Call Permission's ID
      schema:
        type: integer
    limit_2:
      required: false
      name: limit
      in: query
      description: Maximum number of items to return in the list
      schema:
        type: integer
  schemas:
    GroupPut:
      type: object
      properties:
        name:
          type: string
      required:
      - name
    UserEmail:
      type: object
      properties:
        address:
          type: string
        main:
          type: boolean
        confirmed:
          type: boolean
    UserList:
      type: object
      properties:
        total:
          type: integer
          description: The number of users
        filtered:
          type: integer
          description: The number of users matching the searched term
        items:
          type: array
          items:
            $ref: '#/components/schemas/UserResult'
          description: A paginated list of users
    Group:
      type: object
      properties:
        name:
          type: string
        slug:
          type: string
          default: <name>
      required:
      - name
    GetGroupsResult:
      type: object
      properties:
        total:
          type: integer
          description: The number of groups.
        filtered:
          type: integer
          description: The number of groups matching the searched term.
        items:
          type: array
          items:
            $ref: '#/components/schemas/GroupResult'
          description: A paginated list of groups
      required:
      - filtered
      - total
      - items
    UserResult:
      type: object
      properties:
        uuid:
          type: string
        username:
          type: string
        firstname:
          type: string
        lastname:
          type: string
        purpose:
          type: string
          enum:
          - user
          - internal
          - external_api
        tenant_uuid:
          type: string
        emails:
          type: array
          items:
            $ref: '#/components/schemas/UserEmail'
        enabled:
          type: boolean
    Policy:
      type: object
      properties:
        name:
          type: string
        slug:
          type: string
          description: A unique, human readable identifier for this policy
        description:
          type: string
        acl:
          type: array
          items:
            type: string
        shared:
          type: boolean
          description: 'Should be shared to sub-tenants or not. Cannot be changed after creation


            When shared is `true`, then all tenants below this policy''s tenant

            will see it as their own policy with the attribute `read_only: true`.


            Using `shared` attribute will add uniqueness constraints for the slug

            among all policies'' sub-tenants.

            '
      required:
      - name
    GetPoliciesResult:
      type: object
      properties:
        total:
          type: integer
          description: The number of policies matching the searched term
        items:
          type: array
          items:
            $ref: '#/components/schemas/PolicyResult'
          description: A paginated list of policies
      required:
      - total
      - items
    GroupResult:
      type: object
      properties:
        uuid:
          type: string
        name:
          type: string
        slug:
          type: string
        tenant_uuid:
          type: string
        system_managed:
          type: boolean
          description: '*Deprecated* Please use `read_only`'
        read_only:
          type: boolean
    PolicyResult:
      type: object
      allOf:
      - $ref: '#/components/schemas/Policy'
      - properties:
          uuid:
            type: string
          read_only:
            type: boolean
    Error:
      type: object
      properties:
        reason:
          type: array
          items:
            type: string
        timestamp:
          type: array
          items:
            type: string
        status_code:
          type: integer
    GroupRelationCallPermissions:
      description: call permissions configured for this group
      properties:
        call_permissions:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/CallPermissionRelationBase'
    GroupRelationExtensions:
      description: extensions configured for this group
      properties:
        extensions:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ExtensionRelationBase'
    DestinationApplicationDISA:
      title: DestinationApplicationDISA
      allOf:
      - $ref: '#/components/schemas/DestinationApplication'
      - properties:
          application:
            type: string
            description: MUST be 'disa'
          context:
            type: integer
            description: The context of the application
          pin:
            type: string
            description: the pin of the application
        required:
        - application
        - context
    GroupMemberUsers:
      properties:
        users:
          items:
            $ref: '#/components/schemas/GroupMemberUser'
          type: array
      required:
      - users
    DestinationApplicationDirectory:
      title: DestinationApplicationDirectory
      allOf:
      - $ref: '#/components/schemas/DestinationApplication'
      - properties:
          application:
            type: string
            description: MUST be 'directory'
          context:
            type: integer
            description: The context of the application
        required:
        - application
        - context
    DestinationUser:
      title: DestinationUser
      properties:
        type:
          type: string
          description: MUST be 'user'
        user_id:
          type: integer
          description: The id of the user
        ring_time:
          type: number
          format: float
        moh_uuid:
          type: string
          description: The UUID of the music on hold to use instead of a ringback tone.
      required:
      - type
      - user_id
    DestinationOutcall:
      title: DestinationOutcall
      properties:
        type:
          type: string
          description: MUST be 'outcall'
        exten:
          type: string
        outcall_id:
          type: integer
          description: The id of the outcall
      required:
      - type
      - exten
      - outcall_id
    GroupsID:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/GroupID'
          type: array
    DestinationHangup:
      title: DestinationHangup
      properties:
        type:
          type: string
          descript

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