Retrieve all teammates

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.

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

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 paginated list of all current Teammates.

You can use the limit query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the offset query parameter to control the position in the list from which to start retrieving additional items.

To perform a request for the first page of the paginated list of all teammates using the default page size, you can omit the limit and offset query parameters:

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  limit: 500,
6
};
7

8
const request = {
9
  url: `/v3/teammates`,
10
  method: "GET",
11
  qs: queryParams,
12
};
13

14
client
15
  .request(request)
16
  .then(([response, body]) => {
17
    console.log(response.statusCode);
18
    console.log(response.body);
19
  })
20
  .catch((error) => {
21
    console.error(error);
22
  });

If you want to specify a page size of your choice, you can use the limit query parameter. Assume you want a page size of no more than 5 items per request, to retrieve the first page you can use the limit parameter without specifying an offset:

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  limit: 5,
6
};
7

8
const request = {
9
  url: `/v3/teammates`,
10
  method: "GET",
11
  qs: queryParams,
12
};
13

14
client
15
  .request(request)
16
  .then(([response, body]) => {
17
    console.log(response.statusCode);
18
    console.log(response.body);
19
  })
20
  .catch((error) => {
21
    console.error(error);
22
  });

If you want to retrieve items beyond the first page, you can use the offset parameter as follows. Assume you are still working with a page size of 5 as determined by your limit query parameter and you have more than 15 items. To request the fourth page of items, you can use the offset parameter to skip over the first 15 items, i.e. you start retrieving items starting after the first three pages of 5 items each:

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3

4
const queryParams = {
5
  limit: 5,
6
  offset: 15,
7
};
8

9
const request = {
10
  url: `/v3/teammates`,
11
  method: "GET",
12
  qs: queryParams,
13
};
14

15
client
16
  .request(request)
17
  .then(([response, body]) => {
18
    console.log(response.statusCode);
19
    console.log(response.body);
20
  })
21
  .catch((error) => {
22
    console.error(error);
23
  });