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

Get List of Segments



API Overview

api-overview page anchor

Segments are similar to contact lists, except they update dynamically over time as information stored about your contacts or the criteria used to define your segments changes. When you segment your audience, you are able to create personalized Automation emails and Single Sends that directly address the wants and needs of your particular audience.

The Marketing Campaigns Segments V2 API allows you to create, edit, and delete segments as well as retrieve a list of segments or an individual segment by ID.

Note that Twilio SendGrid checks for newly added or modified contacts who meet a segment's criteria on an hourly schedule. Only existing contacts who meet a segment's criteria will be included in the segment searches within 15 minutes.

Segments built using engagement data such as "was sent" or "clicked" will take approximately 30 minutes to begin populating.

Segment samples and counts are refreshed approximately once per hour; they do not update immediately. If no contacts are added to or removed from a segment since the last refresh, the sample and UI count displayed will be refreshed at increasing time intervals with a maximum sample and count refresh delay of 24 hours.


GET/v3/marketing/segments/2.0

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve a list of segments.

The query param parent_list_ids is treated as a filter. Any match will be returned. Zero matches will return a response code of 200 with an empty results array.

parent_list_idsno_parent_list_ididsresult
emptyfalseemptyall segments values
list_idsfalseemptysegments filtered by list_ids values
list_idstrueemptysegments filtered by list_ids and segments with no parent list_ids empty
emptytrueemptysegments with no parent list_ids
anythinganythingidssegments with matching segment ids

Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
idsarrayOptional

A list of segment IDs to retrieve. When this parameter is included, the no_parent_list_ids and parent_list_ids parameters are ignored and only segments with given IDs are returned.


parent_list_idsstringOptional

A comma separated list up to 50 in size, to filter segments on. Only segments that have any of these list ids as the parent list will be retrieved. This is different from the parameter of the same name used when creating a segment.


no_parent_list_idbooleanOptional

If set to true, segments with an empty value of parent_list_id will be returned in the filter. If the value is not present, it defaults to 'false'.

Default: false
200400404500
Schema
Property nameTypeRequiredDescriptionChild properties
idstring<uuid>

ID assigned to the segment when created.

Min length: 36Max length: 36

namestring

Name of the segment.

Min length: 1Max length: 100

contacts_countinteger

Total number of contacts present in the segment


created_atstring

ISO8601 timestamp of when the object was created


updated_atstring

ISO8601 timestamp of when the object was last updated


sample_updated_atstring

ISO8601 timestamp of when the samples were last updated


next_sample_updatestring

ISO8601 timestamp of when the samples will be next updated


parent_list_idsarray[string]

The array of list ids to filter contacts on when building this segment. It allows only one such list id for now. We will support more in future


query_versionstring

If not set, segment contains a query for use with Segment v1 APIs. If set to '2', segment contains a SQL query for use in v2.


_metadataobject

statusobject

Segment status indicates whether the segment's contacts will be updated periodically

Get List of Segments

get-list-of-segments page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/marketing/segments/2.0`,
_18
method: 'GET',
_18
_18
}
_18
_18
client.request(request)
_18
.then(([response, body]) => {
_18
console.log(response.statusCode);
_18
console.log(response.body);
_18
})
_18
.catch(error => {
_18
console.error(error);
_18
});


Rate this page: