Skip to contentSkip to navigationSkip to topbar
On this page

List Offerings



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 offering operations allow you to update and list Twilio SendGrid features or offerings available for your customer accounts.

The List Offerings operation returns all the Twilio SendGrid features or offerings available to a reseller account. These offerings can be assigned to the reseller's customer accounts when creating a new customer account with the Create Account operation. Offerings can be added to or removed from a customer account using the Update Account Offerings operation.

Because the available offerings will change infrequently, you may wish to cache the List Offerings response rather than call the endpoint before each account creation or update.


GET/v3/partners/offerings

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

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

Retrieves offerings available under the organization.


Authentication

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

OK

SchemaExample
Property nameTypeRequiredDescriptionChild properties
catalogarray[object]
Get all offerings available to the reseller accountLink to code sample: Get all offerings available to the reseller account
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
5
const request = {
6
url: `/v3/partners/offerings`,
7
method: 'GET',
8
9
}
10
11
client.request(request)
12
.then(([response, body]) => {
13
console.log(response.statusCode);
14
console.log(response.body);
15
})
16
.catch(error => {
17
console.error(error);
18
});