Contacts API - Lists
Elements that can be shared among more than one endpoint definition.
Retrieve all recipients on a List
GET /v3/contactdb/lists/{list_id}/recipients
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve all recipients on the list with the given ID.
Authentication
- API Key
Headers
Path Parameters
The id of the list of recipients you want to retrieve.
default: NoneQuery String
Page index of first recipient to return (must be a positive integer)
default: NoneNumber of recipients to return at a time (must be a positive integer between 1 and 1000)
default: NoneThe ID of the list whose recipients you are requesting.
default: NoneResponses
The ID of this recipient.
The time this record was created in your contactdb, in unixtime.
The custom fields assigned to this recipient and their values.
The value of this recipient's custom field
The email address of this recipient. This is a default custom field that SendGrid provides.
format: emailThe first name of this recipient. This is a default custom field that SendGrid provides.
The last name of the recipient.
The last time this recipient clicked a link from one of your campaigns, in unixtime.
The last time this user was emailed by one of your campaigns, in unixtime.
The last time this recipient opened an email from you, in unixtime.
The last update date for this recipient's record.
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}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.
