List Meeting Invitees
Lists meeting invitees for a meeting with a specified meetingId. You can set a maximum number of invitees to return.
This operation can be used for meeting series, scheduled meetings, and ended or ongoing meeting instance objects. If the specified meetingId is for a meeting series, the invitees for the series will be listed; if the meetingId is for a scheduled meeting, the invitees for the particular scheduled meeting will be listed; if the meetingId is for an ended or ongoing meeting instance, the invitees for the particular meeting instance will be listed. See the Webex Meetings guide for more information about the types of meetings.
The list returned is sorted in ascending order by email address.
Long result sets are split into pages.
Query Parameters
Unique identifier for the meeting for which invitees are being requested. The meeting can be a meeting series, a scheduled meeting, or a meeting instance which has ended or is ongoing. The meeting ID of a scheduled personal room meeting is not supported for this API.
Limit the maximum number of meeting invitees in the response, up to 100.
Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return meeting invitees that are hosted by that user.
Filter invitees or attendees for webinars only. If true, returns invitees. If false, returns attendees. If null, returns both invitees and attendees.
Response Properties
Array of meeting invitees.
Unique identifier for meeting invitee.
Email address for meeting invitee. This attribute can be modified by Update a Meeting Invitee API.
Display name for meeting invitee. This attribute can be modified by Update a Meeting Invitee API.
Whether or not invitee is a designated alternate host for the meeting. See Add Alternate Hosts for Cisco Webex Meetings for more details.
Unique identifier for the meeting for which invitees are being requested. The meeting can be a meeting series, a scheduled meeting, or a meeting instance which has ended or is ongoing.
If true, the invitee is a designated panelist for the event meeting.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Unique identifier for the meeting for which invitees are being requested. The meeting can be a meeting series, a scheduled meeting, or a meeting instance which has ended or is ongoing. The meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is not supported for this API.
- Limit the maximum number of meeting invitees in the response, up to 100.
- Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return meeting invitees that are hosted by that user.
- Filter invitees or attendees for webinars only. If `true`, returns invitees. If `false`, returns attendees. If `null`, returns both invitees and attendees.
{
"items": [
{
"id": "870f51ff287b41be84648412901e0402_2628957",
"email": "john.andersen@example.com",
"displayName": "John Andersen",
"coHost": false,
"panelist": false,
"meetingId": "870f51ff287b41be84648412901e0402"
},
{
"id": "870f51ff287b41be84648412901e0402_2628962",
"email": "brenda.song@example.com",
"displayName": "Brenda Song",
"coHost": false,
"panelist": false,
"meetingId": "870f51ff287b41be84648412901e0402"
}
]
}