| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/Event/{EventId}/VirtualUsers/{UserEmail} | Return the details for a virtual user. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EventId | path | int | No | |
| UserEmail | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberID | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| User | form | User | No | |
| UserSettings | form | UserSettings | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| form | string | No | ||
| Type | form | UserPlanType | No | |
| Pmi | form | long | No | |
| TimeZone | form | string | No | |
| Verified | form | int | No | |
| Department | form | string | No | |
| CreatedAt | form | DateTime | No | |
| LastLoginTime | form | DateTime | No | |
| PictureURL | form | string | No | |
| AccountID | form | string | No | |
| AccountNumber | form | long | No | |
| Status | form | UserStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ScheduleMeeting | form | UserSettingsScheduleMeeting | No | |
| Feature | form | UserSettingsFeature | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HostVideo | form | bool | No | |
| ParticipantsVideo | form | bool | No | |
| AudioType | form | MeetingAudioType | No | |
| JoinBeforeHost | form | bool | No | |
| ForcePersonalMeetingIDJoinBeforeHostPassword | form | bool | No | |
| GenerateRequirePasscodeForParticipantsByPhone | form | bool | No | |
| UsePersonalMeetingIDWhenSchedulingMeeting | form | bool | No | |
| UsePersonalMeetingIDWhenStartingInstantMeeting | form | bool | No | |
| RequirePasscodeForSchedulingNewMeetings | form | bool | No | |
| RequirePasswordForScheduledMeetings | form | bool | No | |
| DefaultPasswordForScheduledMeetings | form | string | No | |
| RequirePasswordForInstantMeetings | form | bool | No | |
| RequirePasswordForPersonalMeetingIDMeetings | form | RequirePasswordForPMIMeetingsType | No | |
| PersonalMeetingIDPassword | form | string | No | |
| EmbedPasswordInJoinLink | form | bool | No | |
| PersonalMeeting | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MeetingCapacity | form | int | No | |
| LargeMeeting | form | bool | No | |
| large_meeting_capacity | form | int | No | |
| Webinar | form | bool | No | |
| WebinarCapacity | form | int | No | |
| ChinaMeeting | form | bool | No | |
| IndiaMeeting | form | bool | No | |
| ZoomPhone | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Ams/{ClientID}/Event/{EventId}/VirtualUsers/{UserEmail} HTTP/1.1
Host: ws.yourmembership.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"User":{"Id":"String","FirstName":"String","LastName":"String","Email":"String","Type":"Basic","Pmi":0,"TimeZone":"String","Verified":0,"Department":"String","CreatedAt":"0001-01-01T00:00:00.0000000","LastLoginTime":"0001-01-01T00:00:00.0000000","PictureURL":"String","AccountID":"String","AccountNumber":0,"Status":"Active"},"UserSettings":{"ScheduleMeeting":{"HostVideo":false,"ParticipantsVideo":false,"AudioType":"TelephonyAndVoIP","JoinBeforeHost":false,"ForcePersonalMeetingIDJoinBeforeHostPassword":false,"GenerateRequirePasscodeForParticipantsByPhone":false,"UsePersonalMeetingIDWhenSchedulingMeeting":false,"UsePersonalMeetingIDWhenStartingInstantMeeting":false,"RequirePasscodeForSchedulingNewMeetings":false,"RequirePasswordForScheduledMeetings":false,"DefaultPasswordForScheduledMeetings":"String","RequirePasswordForInstantMeetings":false,"RequirePasswordForPersonalMeetingIDMeetings":"OnlyMeetingsWithJoinBeforeHostEnabled","PersonalMeetingIDPassword":"String","EmbedPasswordInJoinLink":false,"PersonalMeeting":false},"Feature":{"MeetingCapacity":0,"LargeMeeting":false,"large_meeting_capacity":0,"Webinar":false,"WebinarCapacity":0,"ChinaMeeting":false,"IndiaMeeting":false,"ZoomPhone":false}},"EventId":0,"UserEmail":"String","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T08:47:28.1769653-04:00","Device":"Desktop"}