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