Retrieve a segment
Legacy Marketing Campaigns
You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns
Info
For the most up-to-date information on the Segments API, please visit the new Marketing Campaigns Segments v2 API.
The Segments API allows you to create and manage segments for your contacts. Segments are used to group contacts based on conditions you set. For example, you might create a segment for contacts who have opened a certain number of your emails, or for contacts who have not opened any of your emails in the last 30 days.
GET/v3/contactdb/segments/{segment_id}
Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)
This endpoint allows you to retrieve a single segment with the given ID.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
Optional
The name of this segment.
Optional
The list id from which to make this segment. Not including this ID will mean your segment is created from the main contactdb rather than a list.
Optional
The conditions for a recipient to be included in this segment.
Optional
The count of recipients in this list. This is not included on creation of segments.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const segment_id = 42;56const request = {7url: `/v3/contactdb/segments/${segment_id}`,8method: "GET",9};1011client12.request(request)13.then(([response, body]) => {14console.log(response.statusCode);15console.log(response.body);16})17.catch((error) => {18console.error(error);19});
