Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve specific teammate



API Overview

api-overview page anchor

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 allows you 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(link takes you to an external page).


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.


GET/v3/teammates/{username}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

This endpoint allows you to retrieve a specific Teammate by username.

You can retrieve the username's for each of your Teammates using the "Retrieve all Teammates" endpoint.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

onBehalfOfstring

Optional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Property nameTypeRequiredDescription
usernamestring
required

The username of the teammate that you want to retrieve.

200
SchemaExample
Property nameTypeRequiredDescriptionChild properties
usernamestring

Optional

Teammate's username


firstNamestring

Optional

Teammate's first name


lastNamestring

Optional

Teammate's last name


emailstring

Optional

Teammate's email


scopesarray

Optional

Scopes associated to teammate


userTypeenum<string>

Optional

Indicate the type of user: account owner, teammate admin user, or normal teammate

Possible values:
adminownerteammate

isAdminboolean

Optional

Set to true if teammate has admin privileges


phonestring

Optional

(optional) Teammate's phone number


websitestring

Optional

(optional) Teammate's website


addressstring

Optional

(optional) Teammate's address


address2string

Optional

(optional) Teammate's address


citystring

Optional

(optional) Teammate's city


statestring

Optional

(optional) Teammate's state


zipstring

Optional

(optional) Teammate's zip


countrystring

Optional

(optional) Teammate's country

Retrieve specific teammateLink to code sample: Retrieve specific teammate
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const username = "username";
5
6
const request = {
7
url: `/v3/teammates/${username}`,
8
method: "GET",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});