Back to ZoomList Im Directory Group Members
Input
type: object
properties:
parameters:
type: object
properties:
groupId:
type: string
example: SobVexyrQjqCkcxjpBWi6w
description: >-
The group ID.<br>
Retrieve by calling the [**List
groups**](/docs/api-reference/zoom-api/methods#operation/groups) API.
page_size:
default: 30
maximum: 300
type: integer
example: 30
description: The number of records returned within a single API call.
page_number:
default: 1
type: integer
example: 1
description: >-
**Deprecated.** We will no longer support this field in a future
release. Instead, use the `next_page_token` for pagination.
next_page_token:
type: string
example: IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2
description: >-
Use the next page token to paginate through large result sets. A next
page token is returned whenever the set of available results exceeds
the current page size. This token's expiration period is 15 minutes.
required:
- groupId
title: Parameters
Output
type: object
title: Group Member List
properties:
next_page_token:
type: string
description: >-
The next page token is used to paginate through large result sets. A next
page token will be returned whenever the set of available results exceeds
the current page size. The expiration period for this token is 15 minutes.
example: w7587w4eiyfsudgf
page_count:
type: integer
description: The number of pages returned for the request made.
example: 1
page_number:
deprecated: true
type: integer
default: 1
description: >-
**Deprecated.** We will no longer support this field in a future release.
Instead, use the `next_page_token` for pagination.
example: 1
page_size:
type: integer
maximum: 300
default: 30
description: The number of records returned with a single API call.
example: 30
total_records:
type: integer
description: The total number of all the records available across pages.
example: 20
members:
description: List of group member objects.
type: array
items:
type: object
properties:
email:
description: User email.
type: string
example:
[email protected]
first_name:
description: User first name.
type: string
example: Jill
id:
description: User ID.
type: string
example: v4iyWT1LTfy8QvPG4GTvdg
last_name:
description: User last name.
type: string
example: Chill
type:
description: |-
User type.<br>
`1` - Basic<br> `2` - Licensed<br>
type: integer
example: 1