Zoom

Zoom IM Group API

The IM Group API from Zoom — 7 operation(s) for im group.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /im/group/create Create an IM group · Im group group create #
Ask an LLM
“How do I set up a new instant messaging group for my team?”
“Can I make an IM group searchable by people in the same domain?”
Tell an agent
Create an IM group named {name}.
Create IM group {name} of type {type}, searchable by domain {option_search_by_domain}.
POST /im/group/delete Delete an IM group · Im group group delete #
Ask an LLM
“Can I remove an instant messaging group we don't use anymore?”
“What comes back after an IM group is deleted?”
Tell an agent destructive · confirm first
Delete IM group {id}.
Remove the instant messaging group {id}.
POST /im/group/edit Edit an IM group's name and search settings · Im group group edit #
Ask an LLM
“Can I rename an existing IM group or change its type?”
“Which search visibility options can I change on an IM group?”
Tell an agent
Rename IM group {id} to {name}.
Change existing IM group {id} to type {type}.
POST /im/group/get Get an IM group's info · Im group group get #
Ask an LLM
“What settings does a particular IM group have?”
“Can I look up one instant messaging group by ID?”
Tell an agent
Get the info for IM group {id}.
Show me the instant messaging group {id}.
POST /im/group/list List all IM groups · Im group group list #
Ask an LLM
“Which instant messaging groups exist on our account?”
“Can I see every IM group we've created?”
Tell an agent
List all IM groups on my account.
List IM groups using API key {api_key} and secret {api_secret}.
POST /im/group/member/delete Remove members from an IM group · Im group group member delete #
Ask an LLM
“Can I take people out of an instant messaging group?”
“Can I remove several IM group members in one call?”
Tell an agent destructive · confirm first
Remove members {member_ids} from IM group {id}.
Take {member_ids} out of instant messaging group {id}.
POST /im/group/member/list List an IM group's members · Im group group member list #
Ask an LLM
“Who is in a particular instant messaging group?”
“Can I page through an IM group's membership?”
Tell an agent
List the members of IM group {id}.
Show page {page_number} of instant messaging group {id}'s members.

Documentation

📖
Documentation
https://developers.zoom.us/docs/api/rest/chat-api/
📖
Documentation
https://developers.zoom.us/docs/api/rest/reference/user/methods/
📖
Documentation
https://developers.zoom.us/docs/api/rest/zoom-phone-api/
📖
Documentation
https://developers.zoom.us/docs/api/
📖
Documentation
https://developers.zoom.us/docs/api/rest/account/
📖
APIReference
https://developers.zoom.us/docs/api/rest/reference/account/methods/
📖
Documentation
https://developers.zoom.us/docs/video-sdk/web/recording/
📖
Documentation
https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/
📖
Documentation
https://developers.zoom.us/docs/api/rest/user/
📖
APIReference
https://developers.zoom.us/docs/api/rest/reference/user/methods/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoom/refs/heads/main/openapi/zoom-im-group-api-openapi.yml

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/zoom-im-group-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

zoom-im-group-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoom REST IM Group API
  description: API Description
  contact:
    name: Zoom Developers
    url: https://zoom.us/developer
    email: developer@zoom.us
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.0.0
servers:
- url: https://api.zoom.us/v1
security:
- api_key: []
- api_secret: []
tags:
- name: IM Group
  description: IM Group operations
paths:
  /im/group/create:
    post:
      tags:
      - IM Group
      description: Create a IM group on Zoom, return the new group info.
      operationId: imGroupGroupCreate
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - name
              type: object
              properties:
                name:
                  type: string
                  description: Group name, must be unique in one account.
                type:
                  type: string
                  description: 'Group type, Normal: normal group, Restricted: Restricted group, Shared: Shared group.'
                  default: Normal
                option_search_by_domain:
                  type: boolean
                  description: Others in the same email domain can search members.
                  default: false
                option_search_by_account:
                  type: boolean
                  description: Others under same account can search members.
                  default: false
                option_search_by_ma:
                  type: boolean
                  description: Others under same master account, including all sub accounts can search members.
                  default: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                group_id: unique_id
                account_id: unique_id
                name: New Group Test
                total_members: 0
                option_search_by_domain: false
                option_search_by_account: false
                option_search_by_ma_account: false
      summary: Im group group create
      x-summary-source: derived
  /im/group/delete:
    post:
      tags:
      - IM Group
      description: Delete a IM group on Zoom, return the deleted group ID.
      operationId: imGroupGroupDelete
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - id
              type: object
              properties:
                id:
                  type: string
                  description: Group ID.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                id: unique_id
                deleted_at: 2015-08-20 08:41:58+00:00
                deleted_count: 1
      summary: Im group group delete
      x-summary-source: derived
  /im/group/edit:
    post:
      tags:
      - IM Group
      description: Edit a IM group on Zoom, return the new group info.
      operationId: imGroupGroupEdit
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - id
              type: object
              properties:
                id:
                  type: string
                  description: Group ID.
                name:
                  type: string
                  description: Group name, must be unique in one account.
                type:
                  type: string
                  description: 'Group type, Normal: normal group, Restricted: Restricted group, Shared: Shared group.'
                  default: Normal
                option_search_by_domain:
                  type: boolean
                  description: Others in the same email domain can search members.
                  default: false
                option_search_by_account:
                  type: boolean
                  description: Others under same account can search members.
                  default: false
                option_search_by_ma:
                  type: boolean
                  description: Others under same master account, including all sub accounts can search members.
                  default: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                group_id: unique_id
                account_id: unique_id
                name: New Group Test
                total_members: 0
                option_search_by_domain: false
                option_search_by_account: true
                option_search_by_ma_account: false
      summary: Im group group edit
      x-summary-source: derived
  /im/group/get:
    post:
      tags:
      - IM Group
      description: Get a IM group on Zoom via ID, return the group info.
      operationId: imGroupGroupGet
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - id
              type: object
              properties:
                id:
                  type: string
                  description: Group ID.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                group_id: unique_id
                account_id: unique_id
                name: Group Test
                total_members: 2
                option_search_by_domain: false
                option_search_by_account: true
                option_search_by_ma_account: false
      summary: Im group group get
      x-summary-source: derived
  /im/group/list:
    post:
      tags:
      - IM Group
      description: List all IM groups on your Zoom account.
      operationId: imGroupGroupList
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - api_key
              - api_secret
              type: object
              properties:
                api_key:
                  type: string
                  description: Your API Key
                api_secret:
                  type: string
                  description: Your API Secret
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                total_records: 1
                groups:
                - group_id: unique_id
                  account_id: unique_id
                  name: Group Test1
                  total_members: 40
                  option_search_by_domain: false
                  option_search_by_account: true
                  option_search_by_ma_account: false
                  last_modified_time: 2016-04-16 07:45:41+00:00
      summary: Im group group list
      x-summary-source: derived
  /im/group/member/delete:
    post:
      tags:
      - IM Group
      description: Delete members of a IM group on Zoom.
      operationId: imGroupGroupMemberDelete
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - id
              - member_ids
              type: object
              properties:
                id:
                  type: string
                  description: Group ID.
                member_ids:
                  type: string
                  description: The member IDs, separated by comma
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                id: unique_id
                deleted_at: 2015-08-20 08:57:38+00:00
                deleted_count: 2
      summary: Im group group member delete
      x-summary-source: derived
  /im/group/member/list:
    post:
      tags:
      - IM Group
      description: Lists the members of a IM group on Zoom.
      operationId: imGroupGroupMemberList
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
              - id
              type: object
              properties:
                id:
                  type: string
                  description: Group ID.
                page_size:
                  type: string
                  description: The amount of records returns within a single API call. Defaults to 30.
                  default: '30'
                page_number:
                  type: string
                  description: Current page number of returned records. Default to 1.
                  default: '1'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                page_count: 1
                page_number: 1
                page_size: 30
                total_records: 1
                members:
                - id: unique_id
                  email: email_address
                  first_name: Zoomie
                  last_name: Userton
                  pic_url: https://ssotest.zoom.us/p/6EoubcvJR7eF2grNXJkrHA/f2003a9c-3095-4865-8536-03cc6f211e86-9569
      summary: Im group group member list
      x-summary-source: derived
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: query
    api_secret:
      type: apiKey
      name: api_secret
      in: query
externalDocs:
  description: Zoom REST API Documentation
  url: https://zoom.github.io/api