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

Get Total Contact Count

Operation overview

operation-overview page anchor

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

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

Responses

responses page anchor
200401403404500
Schema
Property nameTypeRequiredDescriptionChild properties
contact_countinteger

Optional

The total number of contacts.

billable_countinteger

Optional

The count of contacts this month for billing purposes.

Default: 0Minimum: 0
billable_breakdownobject

Optional

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

Get Total Contact CountLink to code sample: Get Total Contact Count
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const request = {

5
  url: `/v3/marketing/contacts/count`,

6
  method: "GET",

7
};

8


9
client

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
  });