Twilio SendGrid's Teammates feature allows multiple users, or "Teammates," to work from a single SendGrid account.
Teammates enables groups of users with different roles and responsibilities to share one account, where each of these users has access to varying SendGrid features depending on their needs. By only giving your individual team members access to the features that they need to do their jobs, you can limit access to sensitive areas of your account. Teammates makes it easy to add, remove, and manage different users. See the Teammate Permissions documentation for more information about managing user permissions.
(information)
Info
Free and Essentials plans allow for adding one Teammate per account and do not offer Single Sign-On (SSO), while Pro and higher plans allow for up to 1,000 Teammates and include SSO and other features. Learn more about the different Email API Plans on our pricing page.
Teammates vs Subusers
You can think of Subusers like subaccounts. Each Subuser account is its own email ecosystem with isolated contacts, templates, suppressions, and data. Subusers feed off their parent account email credits, and all billing rolls up to the parent account. Teammates may have access to a parent account, a group of Subusers, or a single Subuser account only.
Operation overview
GET/v3/teammates/{teammate_name}/subuser_access
Base url: https://api.sendgrid.com
This operation allows you to retrieve the Subusers that can be accessed by a specified Teammate.
This operation will return the Subusers available to a Teammate, including the scopes available. If the Teammate is an administrator, all Subusers will be returned.
Operation details
Authentication
Headers
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Path parameters
Property nameTypeRequiredDescription
teammate_namestringrequired
The username of the Teammate for whom you want to retrieve Subuser access information.
Query string
Property nameTypeRequiredDescription
after_subuser_idintegerOptional
The Subuser ID from which the API request will begin retrieving Subusers. This query parameter can be used in successive API calls to retrieve additional Subusers.
limitintegerOptional
Limit the number of Subusers to be returned. The default limit is 100 per request.
Default: 100
usernamestringOptional
A Subuser's username that will be used to filter the returned result.
When this property is set to true, the Teammate has permissions to operate only on behalf of a Subuser. This property value is true when the subuser_access property is not empty. The subuser_access property determines which Subusers the Teammate may act on behalf of.
subuser_accessarray[object]
Specifies which Subusers the Teammate may access and act on behalf of. If this property is populated, the has_restricted_subuser_access property will be true.
The ID of a Subuser to which the Teammate has access. You can retrieve Subuser IDs from the Subusers API.
usernamestring
The username of a Subuser to which the Teammate has access.
emailstring
The email address of a Subuser to which the Teammate has access.
disabledboolean
Indicates if the Subuser is active for the SendGrid account.
permission_typeenum<string>
The level of access the Teammate has to the specified Subuser. This property value may be either admin or restricted. When is property is set to restricted, the Teammate has only the permissions assigned in the scopes property.
Possible values:
adminrestricted
scopesarray[string]
The permissions or scopes that the Teammate can access on behalf of the Subuser. See Teammate Permissions for a complete list of available scopes.
_metadataobject
This object contains response metadata. The presence of the after_subuser_id property in the metadata indicates that some items are still outstanding and have not been retrieved. You can use the after_subuser_id value to retrieve additional items with another request.