Users
Returns data from the Users table.
Table Specific Information
SELECT
The Cvent API allows you to filter by certain fields when querying for data. The following fields can be filtered by the API:
- Id supports =,!=
- UserName supports =,!=
- Active supports =,!=
- Created supports =,!=,>,<,>=,<=
- LastModified supports =,!=,>,<,>=,<=
All other filters are handled client-side.
The following is an example of a SELECT statement:
SELECT * FROM Users WHERE UserName = '[email protected]'
INSERT
The following is an example of an INSERT statement:INSERT INTO Users (UserName, Active, UserType, GivenName, FamilyName, Timezone, Locale, EmailValue, GroupValue, SendLoginDetails)
VALUES ('[email protected]', 'true', 'Planner Account User','Test','Test','America/New_York', 'en-US', '[email protected]', '1234b4e4-abcd-4a6d-adb7-ce81bbc4e019', true)
UPDATE
The following is an example of an UPDATE statement:UPDATE Users SET UserName='[email protected]', Active=true, UserType='Planner Account User', GivenName='Bob', FamilyName='Test', MiddleName='', Timezone='America/New_York', Locale='en-US', EmailValue='[email protected]', GroupValue='3290b4e4-afce-4a6d-adb7-ce81bbc4e019', SendLoginDetails=true WHERE Id='efbf1234-ce7c-4e6a-951f-8f832365c0d1'
DELETE
The following is an example of a DELETE statement:DELETE FROM Users WHERE Id='efbf1234-ce7c-4e6a-951f-8f832365c0d1'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the Users table. | |
| UserName | String | False |
The UserName of the Users table. | |
| Active | Boolean | False |
The Active of the Users table. | |
| Title | String | False |
The Title of the Users table. | |
| UserType | String | False |
The UserType of the Users table. | |
| Timezone | String | False |
The Timezone of the Users table. | |
| Locale | String | False |
The Locale of the Users table. | |
| GivenName | String | False |
The GivenName of the Users table. | |
| FamilyName | String | False |
The FamilyName of the Users table. | |
| MiddleName | String | False |
The MiddleName of the Users table. | |
| HonorificPrefix | String | False |
The HonorificPrefix of the Users table. | |
| EmailType | String | False |
The EmailType of the Users table. | |
| EmailValue | String | False |
The EmailValue of the Users table. | |
| EmailPrimary | Boolean | False |
The EmailPrimary of the Users table. | |
| GroupValue | String | False |
The GroupValue of the Users table. | |
| GroupDisplay | String | False |
The GroupDisplay of the Users table. | |
| SendLoginDetails | Boolean | False |
The SendLoginDetails of the Users table. | |
| Created | Datetime | False |
Datetime when the record was created. | |
| LastModified | Datetime | False |
Datetime when the record was last updated. |