Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
Rate this page:
On this page

Get Total Contact Count

Operation overview

operation-overview page anchor

GET/v3/marketing/contacts/count

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

This endpoint returns the total number of contacts you have stored.

Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

Responses

responses page anchor
200401403404500
Schema
Property nameTypeRequiredDescriptionChild properties
contact_countinteger

The total number of contacts.

billable_countinteger

The count of contacts this month for billing purposes.

Minimum: 0Default: 0
billable_breakdownobject

billable_breakdown will only appear to the parent user in an account with subusers.

Get Total Contact Count

get-total-contact-count page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/marketing/contacts/count`,
_18
method: 'GET',
_18
_18
}
_18
_18
client.request(request)
_18
.then(([response, body]) => {
_18
console.log(response.statusCode);
_18
console.log(response.body);
_18
})
_18
.catch(error => {
_18
console.error(error);
_18
});

Rate this page: