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
The on-behalf-of
header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>
). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>
). See On Behalf Of for more information.
Responses
The reference ID of your list.
The name of your list. Must be unique against all other list and segment names.
The count of recipients currently in the list.
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.