Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

List all Subusers



API Overview

api-overview page anchor

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console(link takes you to an external page).


GET/v3/subusers

Base url: https://api.sendgrid.com

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.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
usernamestringOptional

The username of this subuser.


limitintegerOptional

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. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)

Default: allPossible values:
allglobaleu

include_regionbooleanOptional

Optional flag to include the regions of the Subusers in the response. If not provided, the region will be omitted from the response. (Regional email is in Public Beta and requires SendGrid Pro plan or above.)

Default: false

offsetintegerOptional

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
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

retrieving-paginated-results page anchor

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

retrieve-first-page-from-list-of-all-subusers page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_21
const client = require('@sendgrid/client');
_21
client.setApiKey(process.env.SENDGRID_API_KEY);
_21
_21
const queryParams = {
_21
"region": "all"
_21
};
_21
_21
const request = {
_21
url: `/v3/subusers`,
_21
method: 'GET',
_21
qs: queryParams
_21
}
_21
_21
client.request(request)
_21
.then(([response, body]) => {
_21
console.log(response.statusCode);
_21
console.log(response.body);
_21
})
_21
.catch(error => {
_21
console.error(error);
_21
});

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

retrieve-first-page-from-list-of-all-subusers-with-a-specified-page-size page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const queryParams = {
_22
"limit": 5,
_22
"region": "all"
_22
};
_22
_22
const request = {
_22
url: `/v3/subusers`,
_22
method: 'GET',
_22
qs: queryParams
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
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

retrieve-a-specific-page-from-the-list-of-all-subusers page anchor

Using the offset query parameter in combination with the limit query parameter

Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_23
const client = require('@sendgrid/client');
_23
client.setApiKey(process.env.SENDGRID_API_KEY);
_23
_23
const queryParams = {
_23
"limit": 5,
_23
"region": "all",
_23
"offset": 15
_23
};
_23
_23
const request = {
_23
url: `/v3/subusers`,
_23
method: 'GET',
_23
qs: queryParams
_23
}
_23
_23
client.request(request)
_23
.then(([response, body]) => {
_23
console.log(response.statusCode);
_23
console.log(response.body);
_23
})
_23
.catch(error => {
_23
console.error(error);
_23
});


Rate this page: