Get sub account details

v1.0.0

Get details of a sub account that is listed under a master account. Your account must be a master account in order to retrieve sub accounts' details. Zoom allows only to use master APIs and create sub accounts. Email the partner programs team at for more details.

Prerequisites:

Pro or a higher paid account with master account option enabled.

Scope: account:write:admin
: Light

Input

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string"
    }
  },
  "required": [
    "accountId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Account creation date and time."
    },
    "id": {
      "type": "string",
      "description": "Account ID."
    },
    "options": {
      "type": "object",
      "description": "Account options object.",
      "properties": {
        "billing_auto_renew": {
          "type": "boolean",
          "description": "Toggle whether automatic billing renewal is on or off."
        },
        "meeting_connector_list": {
          "type": "array",
          "description": "Specify the IP addresses of the Meeting Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Meeting Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_mc` is set to `true`.",
          "items": {
            "type": "string"
          }
        },
        "pay_mode": {
          "type": "string",
          "description": "Payee:<br>`master` - master account holder pays.<br>`sub` - Sub account holder pays.",
          "enum": [
            "master",
            "sub"
          ]
        },
        "room_connector_list": {
          "type": "array",
          "description": "Specify the IP addresses of the Room Connectors that you would like to share with the sub account. Multiple values can be separated by comma. If no value is provided in this field, all the Room Connectors of a master account will be shared with the sub account.\n\n\n**Note:** This option can only be used if the value of `share_rc` is set to `true`.",
          "items": {
            "type": "string"
          }
        },
        "share_mc": {
          "type": "boolean",
          "description": "Enable/disable the option for a sub account to use shared [Meeting Connector(s)](https://support.zoom.us/hc/en-us/articles/201363093-Getting-Started-with-the-Meeting-Connector) that are set up by the master account. Meeting Connectors can only be used by On-prem users."
        },
        "share_rc": {
          "type": "boolean",
          "description": "Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users."
        }
      }
    },
    "owner_email": {
      "type": "string",
      "description": "Account owner email."
    },
    "owner_id": {
      "type": "string",
      "description": "Account owner ID."
    },
    "vanity_url": {
      "type": "string",
      "description": "Account Vanity URL"
    }
  }
}