type: object
properties:
parameters:
type: object
properties:
meetingId:
format: int64
type: integer
example: 85746065
description: |-
The meeting's ID.
When storing this value in your database, you must store it as a long format integer and **not** an integer. Meeting IDs can exceed 10 digits.
occurrence_id:
type: string
example: '1648194360000'
description: The meeting or webinar occurrence ID.
status:
default: approved
enum:
- pending
- approved
- denied
type: string
example: pending
description: |-
Query by the registrant's status:
* `pending` — The registration is pending.
* `approved` — The registrant is approved.
* `denied` — The registration is denied.
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:
- meetingId
title: Parameters
type: object
title: Registration 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
registrants:
description: List of registrant objects.
type: array
items:
type: object
properties:
id:
description: Registrant ID.
type: string
example: 9tboDiHUQAeOnbmudzWa5g
address:
description: The registrant's address.
type: string
example: 1800 Amphibious Blvd.
city:
description: The registrant's city.
type: string
example: Mountain View
comments:
description: The registrant's questions and comments.
type: string
example: Looking forward to the discussion.
country:
description: >-
The registrant's two-letter [country
code](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).
type: string
example: US
custom_questions:
description: Information about custom questions.
type: array
items:
type: object
properties:
title:
type: string
description: The title of the custom question.
example: What do you hope to learn from this?
value:
type: string
maxLength: 128
description: >-
The custom question's response value. This has a limit of 128
characters.
example: >-
Look forward to learning how you come up with new recipes and
what other services you offer.
email:
description: >-
The registrant's email address. See [Email address display
rules](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#email-address)
for return value details.
format: email
maxLength: 128
type: string
example:
[email protected]
first_name:
description: The registrant's first name.
maxLength: 64
type: string
example: Jill
industry:
description: The registrant's industry.
type: string
example: Food
job_title:
description: The registrant's job title.
type: string
example: Chef
last_name:
description: The registrant's last name.
maxLength: 64
type: string
example: Chill
no_of_employees:
description: |-
The registrant's number of employees:
* `1-20`
* `21-50`
* `51-100`
* `101-250`
* `251-500`
* `501-1,000`
* `1,001-5,000`
* `5,001-10,000`
* `More than 10,000`
enum:
- ''
- 1-20
- 21-50
- 51-100
- 101-250
- 251-500
- 501-1,000
- 1,001-5,000
- 5,001-10,000
- More than 10,000
type: string
example: 1-20
org:
description: The registrant's organization.
type: string
example: Cooking Org
phone:
description: The registrant's phone number.
type: string
example: '5550100'
purchasing_time_frame:
description: |-
The registrant's purchasing time frame:
* `Within a month`
* `1-3 months`
* `4-6 months`
* `More than 6 months`
* `No timeframe`
enum:
- ''
- Within a month
- 1-3 months
- 4-6 months
- More than 6 months
- No timeframe
type: string
example: 1-3 months
role_in_purchase_process:
description: |-
The registrant's role in the purchase process:
* `Decision Maker`
* `Evaluator/Recommender`
* `Influencer`
* `Not involved`
enum:
- ''
- Decision Maker
- Evaluator/Recommender
- Influencer
- Not involved
type: string
example: Influencer
state:
description: The registrant's state or province.
type: string
example: CA
status:
description: >-
The status of the registrant's registration. <br> `approved`: User
has been successfully approved for the webinar.<br> `pending`: The
registration is still pending.<br> `denied`: User has been denied
from joining the webinar.
enum:
- approved
- denied
- pending
type: string
example: approved
zip:
description: The registrant's ZIP or postal code.
type: string
example: '94045'
create_time:
description: The time at which the registrant registered.
format: date-time
type: string
example: '2022-03-22T05:59:09Z'
join_url:
description: >-
The URL using which an approved registrant can join the meeting or
webinar.
format: string
type: string
example: https://example.com/j/11111
participant_pin_code:
description: >-
The participant PIN code is used to authenticate audio participants
before they join the meeting.
type: integer
format: int64
example: 380303