Skip to contentSkip to navigationSkip to topbar
On this page

List Accounts



API Overview

api-overview page anchor

The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customers. This API is for companies that have a formal reseller partnership with Twilio SendGrid.

You can access Twilio SendGrid sub-account functionality without becoming a reseller. If you require sub-account functionality, see the Twilio SendGrid Subusers feature, which is available with Pro and Premier plans(link takes you to an external page).

The Account Provisioning API account operations allow you to create, retrieve, and authenticate customer accounts.

The List Accounts operation allows you to retrieve all customer accounts belonging to your reseller account. Accounts are returned with their account IDs, email addresses, and account creation and update information.

This endpoint returns 10 results per request by default. You can receive a maximum of 100 results per request by setting the limit query parameter. If you have more than 100 customer accounts, you can use the offset and limit query parameters to iterate through your accounts in successive API calls to the endpoint.


GET/v3/partners/accounts

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

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

Retrieves all accounts under the organization.


Authentication

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

Optional

The last item successfully retrieved


limitinteger

Optional

The number of items to return

Maximum: 100Default: 10
200400401403404

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
accountsarray[object]

List of account objects.


pagesobject
List all customer accountsLink to code sample: List all customer accounts
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const queryParams = {
5
limit: 10,
6
};
7
8
const request = {
9
url: `/v3/partners/accounts`,
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
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.