Zoom Users Tools — Ferrule Docs

MCPREST

GETlist_contact_groups/contact-groups

List all contact groups for the authenticated user's account.

Request

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

groupsarray

next_page_tokenstring

page_sizenumber

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_contact_groups"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_contact_groups",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/contact-groups
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "groups": [],
  "next_page_token": "...",
  "page_size": 0
}

GETget_contact_group/contact-groups/:groupId

Get a single contact group by ID. Returns group name and member count.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Contact group ID

Response

group_idstring

group_namestring

total_membersnumber

group_privacyobject

descriptionstring

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_contact_group"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_contact_group",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/contact-groups/:groupId
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "group_id": "...",
  "group_name": "...",
  "total_members": 0,
  "group_privacy": null,
  "description": "..."
}

GETlist_contact_group_members/contact-groups/:groupId/members

List members of a specific contact group.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Contact group ID

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

group_membersarray

next_page_tokenstring

page_sizenumber

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_contact_group_members"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_contact_group_members",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/contact-groups/:groupId/members
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "group_members": [],
  "next_page_token": "...",
  "page_size": 0
}

GETlist_divisions/divisions

List all divisions in the account.

Request

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

next_page_tokenstring

page_sizenumber

total_recordsnumber

divisionsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_divisions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_divisions",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/divisions
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "next_page_token": "...",
  "page_size": 0,
  "total_records": 0,
  "divisions": []
}

GETget_division/divisions/:divisionId

Get a single division by ID.

Request

Path Parameters

Name	Type	Required	Description
divisionId	string	Yes	Division ID

Response

division_idstring

division_namestring

division_descriptionstring

is_main_divisionboolean

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_division"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_division",
      "params": {
        "divisionId": "<divisionId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/divisions/:divisionId
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "division_id": "...",
  "division_name": "...",
  "division_description": "...",
  "is_main_division": false
}

GETlist_division_members/divisions/:divisionId/members

List members of a specific division.

Request

Path Parameters

Name	Type	Required	Description
divisionId	string	Yes	Division ID

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

next_page_tokenstring

page_sizenumber

total_recordsnumber

usersarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_division_members"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_division_members",
      "params": {
        "divisionId": "<divisionId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/divisions/:divisionId/members
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "next_page_token": "...",
  "page_size": 0,
  "total_records": 0,
  "users": []
}

GETlist_groups/groups

List all groups in the account.

Request

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

groupsarray

total_recordsnumber

next_page_tokenstring

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_groups"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_groups",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "groups": [],
  "total_records": 0,
  "next_page_token": "..."
}

GETget_group/groups/:groupId

Get a single group by ID. Returns group name, member count, and total members.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Group ID

Response

idstring

namestring

total_membersnumber

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_group"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_group",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups/:groupId
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "id": "...",
  "name": "...",
  "total_members": 0
}

GETlist_group_admins/groups/:groupId/admins

List admins of a specific group.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Group ID

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

adminsarray

next_page_tokenstring

page_sizenumber

total_recordsnumber

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_group_admins"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_group_admins",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups/:groupId/admins
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "admins": [],
  "next_page_token": "...",
  "page_size": 0,
  "total_records": 0
}

GETlist_group_channels/groups/:groupId/channels

List channels of a specific group.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Group ID

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

channelsarray

group_idstring

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_group_channels"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_group_channels",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups/:groupId/channels
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "channels": [],
  "group_id": "..."
}

GETget_group_lock_settings/groups/:groupId/lock-settings

Get locked settings for a group. Shows which settings are locked by admin.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Group ID

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_group_lock_settings"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_group_lock_settings",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups/:groupId/lock-settings
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_group_members/groups/:groupId/members

List members of a specific group.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Group ID

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

membersarray

next_page_tokenstring

page_countnumber

page_numbernumber

page_sizenumber

total_recordsnumber

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_group_members"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_group_members",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups/:groupId/members
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "members": [],
  "next_page_token": "...",
  "page_count": 0,
  "page_number": 0,
  "page_size": 0,
  "total_records": 0
}

GETget_group_settings/groups/:groupId/settings

Get settings for a group. Returns meeting, recording, and telephony settings.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Group ID

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_group_settings"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_group_settings",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups/:groupId/settings
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETget_group_webinar_registration_settings/groups/:groupId/settings/registration

Get webinar registration settings for a group.

Request

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Group ID

Response

optionsobject

questionsarray

approve_typeobject

custom_questionsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_group_webinar_registration_settings"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_group_webinar_registration_settings",
      "params": {
        "groupId": "<groupId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/groups/:groupId/settings/registration
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "options": {
    "host_email_notification": false,
    "close_registration": false,
    "allow_participants_to_join_from_multiple_devices": false,
    "show_social_share_buttons": false
  },
  "questions": [],
  "approve_type": null,
  "custom_questions": []
}

GETlist_users/users

List users in the account with optional filters by status, page size, or role.

Request

Query Parameters

Name	Type	Required	Description
status	string	No	Filter by user status
role_id	string	No	Filter by role ID

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

next_page_tokenstring

page_countnumber

page_numbernumber

page_sizenumber

total_recordsnumber

usersarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_users"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_users",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "next_page_token": "...",
  "page_count": 0,
  "page_number": 0,
  "page_size": 0,
  "total_records": 0,
  "users": []
}

GETcheck_user_email/users/email

Check if an email address is registered with Zoom. Returns whether the email exists.

Request

Query Parameters

Name	Type	Required	Description
email	string	No	Email address to check

Response

existed_emailboolean

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "check_user_email"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "check_user_email",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/email
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "existed_email": false
}

GETget_user_zak/users/me/zak

Get the authenticated user's Zoom Access Key (ZAK) token for starting meetings.

Request

No input parameters.

Response

tokenstring

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_zak"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_zak",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/me/zak
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "token": "..."
}

GETget_user_summary/users/summary

Get a summary of user counts by status (active, inactive, pending) for the account.

Request

No input parameters.

Response

licensed_users_countnumber

basic_users_countnumber

on_prem_users_countnumber

room_users_countnumber

pending_users_countnumber

join_only_users_countnumber

total_users_countnumber

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_summary"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_summary",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/summary
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "licensed_users_count": 0,
  "basic_users_count": 0,
  "on_prem_users_count": 0,
  "room_users_count": 0,
  "pending_users_count": 0,
  "join_only_users_count": 0,
  "total_users_count": 0
}

GETcheck_user_pm_room/users/vanity-name

Check if a personal meeting room name (vanity URL) is available.

Request

Query Parameters

Name	Type	Required	Description
vanity_name	string	No	Personal meeting room name to check

Response

existedboolean

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "check_user_pm_room"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "check_user_pm_room",
      "params": {}
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/vanity-name
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "existed": false
}

GETget_user/users/:userId

Get a single user by ID or email. Returns profile, plan, and feature details. Use 'me' for authenticated user.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email. Use 'me' for authenticated user.

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_user_assistants/users/:userId/assistants

List assistants assigned to a user.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

assistantsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_user_assistants"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_user_assistants",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/assistants
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "assistants": []
}

GETlist_user_collaboration_devices/users/:userId/collaboration-devices

List collaboration devices assigned to a user.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

total_recordsnumber

collaboration_devicesarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_user_collaboration_devices"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_user_collaboration_devices",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/collaboration-devices
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "total_records": 0,
  "collaboration_devices": []
}

GETget_user_collaboration_device/users/:userId/collaboration-devices/:collaborationDeviceId

Get a specific collaboration device for a user.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email
collaborationDeviceId	string	Yes	Collaboration device ID

Response

idstring

device_namestring

room_namestring

room_user_idstring

statusobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_collaboration_device"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_collaboration_device",
      "params": {
        "userId": "<userId>",
        "collaborationDeviceId": "<collaborationDeviceId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/collaboration-devices/:collaborationDeviceId
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "id": "...",
  "device_name": "...",
  "room_name": "...",
  "room_user_id": "...",
  "status": null
}

GETget_user_meeting_summary_templates/users/:userId/meeting-summary-templates

Get meeting summary templates for a user.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Response

array of:

meeting_summary_template_idstring

namestring

descriptionstring

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_meeting_summary_templates"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_meeting_summary_templates",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/meeting-summary-templates
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETget_user_meeting_template/users/:userId/meeting-templates/:meetingTemplateId

Get a specific meeting template for a user.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email
meetingTemplateId	string	Yes	Meeting template ID

Response

idstring

namestring

settingsobject

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_meeting_template"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_meeting_template",
      "params": {
        "userId": "<userId>",
        "meetingTemplateId": "<meetingTemplateId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/meeting-templates/:meetingTemplateId
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "id": "...",
  "name": "...",
  "settings": {
    "in_meeting": {
      "entry_exit_chime": null,
      "feedback": false,
      "polling": false,
      "post_meeting_feedback": false,
      "screen_sharing": false,
      "who_can_share_screen": null,
      "who_can_share_screen_when_someone_is_sharing": null,
      "disable_screen_sharing_for_host_meetings": false,
      "annotation": false,
      "whiteboard": false,
      "remote_control": false,
      "non_verbal_feedback": false,
      "allow_participants_to_rename": false,
      "breakout_room": false,
      "remote_support": false,
      "manual_captioning": {
        "auto_generated_captions": false,
        "allow_to_type": false,
        "manual_captions": false,
        "save_captions": false
      },
      "closed_captioning": {
        "auto_transcribing": false,
        "enable": false,
        "save_caption": false
      }
    },
    "recording": {
      "auto_recording": null
    },
    "schedule_meeting": {
      "host_video": false,
      "participant_video": false,
      "mute_upon_entry": false
    },
    "meeting_security": {
      "waiting_room": false
    }
  }
}

GETget_user_permissions/users/:userId/permissions

Get permissions assigned to a user. Returns list of permission strings.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Response

permissionsarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_permissions"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_permissions",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/permissions
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "permissions": []
}

GETget_user_presence_status/users/:userId/presence-status

Get a user's presence status (available, away, do not disturb, etc.).

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_presence_status"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_presence_status",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/presence-status
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETlist_user_schedulers/users/:userId/schedulers

List schedulers assigned to a user. Schedulers can schedule meetings on behalf of the user.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Pagination

Name	Type	Required	Description
next_page_token	string	No	Token for paginating to the next page. Returned in previous list response. Expires after 15 minutes.
page_size	number	No	Number of records per page. Defaults and maximums vary by endpoint.

Response

schedulersarray

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "list_user_schedulers"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "list_user_schedulers",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/schedulers
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "schedulers": []
}

GETget_user_settings/users/:userId/settings

Get settings for a user. Returns meeting, recording, telephony, and feature settings.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Response

unknown

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_settings"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_settings",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/settings
Authorization: Bearer <your-api-key>
Content-Type: application/json

GETget_user_token/users/:userId/token

Get a user's token. Can retrieve either a regular token or a ZAK token.

Request

Path Parameters

Name	Type	Required	Description
userId	string	Yes	User ID or email

Query Parameters

Name	Type	Required	Description
type	string	No	Token type to retrieve

Response

tokenstring

Examples

1. Describe method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_method",
    "arguments": {
      "service": "zoom-users",
      "method": "get_user_token"
    }
  }
}

2. Call method

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "call_zoom-users",
    "arguments": {
      "method": "get_user_token",
      "params": {
        "userId": "<userId>"
      }
    }
  }
}

Request

GET https://app.ferrule.io/api/v1/zoom-users/users/:userId/token
Authorization: Bearer <your-api-key>
Content-Type: application/json

Response

{
  "token": "..."
}