Menu

Expand
Rate this page:

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.

        
        
        
        Rate this page:

        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.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more