Get All Lists

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

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

This endpoint returns an array of all of your contact lists.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Query string

Property nameTypeRequiredDescription

page_sizenumber

Optional

Maximum number of elements to return. Defaults to 100, returns 1000 max

Default: 100Minimum: 1Maximum: 1000

page_tokenstring

Optional

Responses

200

SchemaExample

Property nameTypeRequiredDescriptionChild properties

resultarray[list]

Optional

Show result properties

_metadatametadata

Optional

Show _metadata properties

Get All Lists

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