Skip to contentSkip to navigationSkip to topbar
Rate this page:
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

Retrieves all accounts under the organization.


Authentication

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

The last item successfully retrieved


limitintegerOptional

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 accounts

list-all-customer-accounts 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
"limit": 10
_21
};
_21
_21
const request = {
_21
url: `/v3/partners/accounts`,
_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
});


Rate this page: