Skip to content Skip to navigation Skip to topbar

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

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

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

idstringrequired

Responses

200404

SchemaExample

Property nameTypeRequiredDescriptionChild properties

contact_countinteger

billable_countinteger

Get List Contact Count

Node.js

Python

Java

PHP

Ruby

curl


_19const client = require('@sendgrid/client');
_19client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19const id = "ZGkrHSypTsudrGkmdpJJ";
_19
_19const request = {
_19  url: `/v3/marketing/lists/${id}/contacts/count`,
_19  method: 'GET',
_19  
_19}
_19
_19client.request(request)
_19  .then(([response, body]) => {
_19    console.log(response.statusCode);
_19    console.log(response.body);
_19  })
_19  .catch(error => {
_19    console.error(error);
_19  });