Get List Contact Count

API Overview

Lists are static collections of Marketing Campaigns contacts. This API allows you to interact with the list objects themselves. To add contacts to a list, you must use the Contacts API.

You can also manage your lists using the Contacts menu in the Marketing Campaigns UI. For more information about lists and best practices for building them, see "Building your Contact List".

Operation overview

GET/v3/marketing/lists/{id}/contacts/count

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

This endpoint returns the number of contacts on a specific list.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

idstring

required

Responses

200404

SchemaExample

Property nameTypeRequiredDescriptionChild properties

contact_countinteger

Optional

billable_countinteger

Optional

Get List Contact Count

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