Teammates
Query Teammates in SendGrid.
View-Specific Information
Select
The add-in will use the SendGrid API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the add-in.- Username supports the '=,IN' comparisons.
For example, the following queries are processed server side:
SQL
SELECT * FROM Teammates WHERE Username = 'test'
SELECT * FROM Teammates WHERE Username IN ('test', 'test2')
Insert
The following columns are required in an insert: Email and Scopes. Scopes column accepts a comma separated list of values. The accepted values are: user.account.read, user.credits.read, user.email.create, user.email.read, user.email.update, user.email.delete, user.profile.create, user.profile.read, user.profile.update, user.profile.delete.
The IsAdmin is optional and by default is accepted as false from the API.
INSERT INTO Teammates (Email, Scopes) VALUES ('[email protected]', 'user.profile.read, user.profile.update')
INSERT INTO Teammates (Email, Scopes, IsAdmin) VALUES ('[email protected]', 'user.profile.read, user.profile.update', 'true')
Update
The following columns are required in an update: Username and Scopes. Scopes column accepts a comma separated list of values. The accepted values are: user.account.read, user.credits.read, user.email.create, user.email.read, user.email.update, user.email.delete, user.profile.create, user.profile.read, user.profile.update, user.profile.delete.
UPDATE Teammates SET Scopes = 'user.profile.read' WHERE Username = 'testuser'
Delete
Only the username column is required to delete a record from Teammates table. For example:
DELETE FROM Teammates WHERE Username = 'testuser'
Columns
| Name | Type | ReadOnly | References | Description |
| Username [KEY] | String | False |
The username of the teammate. | |
| String | False |
Email of the teammate. | ||
| FirstName | String | False |
First name of the teammate. | |
| LastName | String | False |
Last name of the teammate. | |
| UserType | String | False |
User type of the teammate. | |
| IsAdmin | Boolean | False |
Indicator if the teammate is admin. | |
| Phone | String | False |
Phone of the teammate. | |
| Website | String | False |
Website of the teammate. | |
| Company | String | False |
Company of the teammate. | |
| Address | String | False |
Address of the teammate. | |
| Address2 | String | False |
Address 2 of the teammate. | |
| City | String | False |
City of the teammate. | |
| State | String | False |
State of the teammate. | |
| Country | String | False |
Country of the teammate. | |
| Zip | String | False |
Zip of the teammate. | |
| Scopes | String | False |
Scope of the permissions for the new teammate. Multiple values are allowed and should be split by a comma symbol. Possible values are: user.account.read,user.credits.read,user.email.create,user.email.read,user.email.update,user.email.delete,user.profile.create,user.profile.read,user.profile.update,user.profile.delete | |
| IsPartnerSSO | Boolean | False |
Indicator if the teammate partner is SSO. | |
| IsSSO | Boolean | False |
Indicator if the teammate is SSO. | |
| IsUnified | Boolean | False |
Indicator if the teammate is unified. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| AccountId | String |
The ID of the account. |
| SubuserUsername | String |
The username of the subuser. |