Contacts API - Lists
Elements that can be shared among more than one endpoint definition.
Retrieve all lists
GET /v3/contactdb/lists
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned.
Authentication
- API Key
Headers
Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.
Responses
object
lists
array[object]
required
id
integer
The reference ID of your list.
name
string
The name of your list. Must be unique against all other list and segment names.
recipient_count
integer
The count of recipients currently in the list.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.