Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Retrieve a segment



API Overview

api-overview page anchor
(warning)

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

(information)

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

This endpoint allows you to retrieve a single segment with the given ID.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

segment_idstringrequired
segment_idintegerrequired

The ID of the segment you want to request.

200400401404
SchemaExample
namestring

The name of this segment.


list_idinteger

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.


conditionsarray[object]

The conditions for a recipient to be included in this segment.


recipient_countnumber

The count of recipients in this list. This is not included on creation of segments.

Retrieve a segment

retrieve-a-segment page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_22
const client = require('@sendgrid/client');
_22
client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22
const segment_id = "ZGkrHSypTsudrGkmdpJJ";
_22
const queryParams = {
_22
"segment_id": 4900
_22
};
_22
_22
const request = {
_22
url: `/v3/contactdb/segments/${segment_id}`,
_22
method: 'GET',
_22
qs: queryParams
_22
}
_22
_22
client.request(request)
_22
.then(([response, body]) => {
_22
console.log(response.statusCode);
_22
console.log(response.body);
_22
})
_22
.catch(error => {
_22
console.error(error);
_22
});


Rate this page: