Lists
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".
Get a List by ID
GET /v3/marketing/lists/{id}
Base url: https://api.sendgrid.com
This endpoint returns data about a specific list.
Setting the optional parameter contact_sample=true returns the contact_sample in the response body. Up to fifty of the most recent contacts uploaded or attached to a list will be returned, sorted alphabetically, by email address.
The full contact count is also returned.
Authentication
- API Key
Headers
Path Parameters
The ID of the Event Webhook you want to retrieve.
default: NoneQuery String
Setting this parameter to the true will cause the contact_sample to be returned
default: FalseResponses
The generated ID for your list.
maxLength: 36minLength: 36The name you gave your list.
The number of contacts currently stored on the list.
A link to this object.
A link to this object.
Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
