On this page

List all Subusers

API Overview

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console.

Operation overview

GET/v3/subusers

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 your subusers.

You can use the username query parameter to filter the list for specific subusers.

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.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Query string

Property nameTypeRequiredDescription

usernamestring

Optional

The username of this subuser.

limitinteger

Optional

limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.

regionenum<string>

Optional

Filter for Subusers in this region. If not provided, all Subusers will be returned. All users can also be explicitly requested by using the filter all. Users who are not pinned to a region will be displayed as global.

Default: allPossible values:

allglobaleu

include_regionboolean

Optional

Optional flag to include the regions of the Subusers in the response. If not provided, the region will be omitted from the response.

Default: false

offsetinteger

Optional

The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the offset to the page size as determined by limit. Use multiples of the page size as your offset to request further consecutive pages. E.g. assume your page size is set to 10. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list.

Minimum: 0Default: 0

Responses

200401

SchemaExample

Array of:

Property nameTypeRequiredDescriptionChild properties

disabledboolean

Whether or not the user is enabled or disabled.

idnumber

The ID of this subuser.

usernamestring

The name by which this subuser will be referred.

emailstring<email>

The email address to contact this subuser.

regionenum<string>

The region this Subuser is assigned to. This property is returned only if the include_region parameter was included and set to true in the API request.

Possible values:

globaleu

Retrieving paginated results

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

Retrieve first page from list of all subusers

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

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:

Retrieve first page from list of all subusers with a specified page size

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  limit: 5,
6};
7
8const request = {
9  url: `/v3/subusers`,
10  method: "GET",
11  qs: queryParams,
12};
13
14client
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:

Retrieve a specific page from the list of all subusers

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const queryParams = {
5  limit: 5,
6  offset: 15,
7};
8
9const request = {
10  url: `/v3/subusers`,
11  method: "GET",
12  qs: queryParams,
13};
14
15client
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  });