On this page

Get Total Contact Count

Operation overview

GET/v3/marketing/contacts/count

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

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

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Responses

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.

Show child properties for billable_breakdown

Get Total Contact Count

1const client = require("@sendgrid/client");
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const request = {
5  url: `/v3/marketing/contacts/count`,
6  method: "GET",
7};
8
9client
10  .request(request)
11  .then(([response, body]) => {
12    console.log(response.statusCode);
13    console.log(response.body);
14  })
15  .catch((error) => {
16    console.error(error);
17  });