Contacts API - Segments
Elements that can be shared among more than one endpoint definition.
Retrieve recipients on a segment
GET /contactdb/segments/{segment_id}/recipients
This endpoint allows you to retrieve all of the recipients in a segment with the given ID.
Authentication
- API Key
Headers
Path Parameters
The ID of the segment from which you want to retrieve recipients.
default: NoneQuery String
number of results to return
default: 100Responses
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; 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.