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

Get List Contact Count

API Overview

api-overview page anchor

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(link takes you to an external page). For more information about lists and best practices for building them, see "Building your Contact List".

Operation overview

operation-overview page anchor

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

operation-details page anchor

Authentication

authentication page anchor

Headers

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

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
idstring
required

Responses

responses page anchor
200404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
contactCountinteger

Optional

billableCountinteger

Optional

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

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

3


4
const id = "id";

5


6
const request = {

7
  url: `/v3/marketing/lists/${id}/contacts/count`,

8
  method: "GET",

9
};

10


11
client

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