Segment List Endpoint

get

/segments/list

This endpoint allows you to export a list of segments, each of which will include its name, Segment API Identifier, and whether it has analytics tracking enabled. The segments are returned in groups of 100 sorted by time of creation (oldest to newest by default). Archived segments are not included.

Parameters

Parameter Required Data Type Description
api_key Yes String App Group REST API Key
page No Integer The page of segments to return, defaults to 0 (returns the first set of up to 100)
sort_direction No String Pass in the value desc to sort by creation time from newest to oldest. Pass in asc to sort from oldest to newest. If sort_direction is not included, the default order is oldest to newest.

Example URL

https://rest.iad-01.braze.com/segments/list?api_key=75480f9a-4db8-4057-8b7e-4d59bfd73709&page=1

Response

Content-Type: application/json

1
2
3
4
5
6
7
8
9
10
11
12
{
    "message": (required, string) the status of the export, returns 'success' when completed without errors,
    "segments" : [
        {
            "id" : (string) Segment API Identifier,
            "name" : (string) segment name,
            "analytics_tracking_enabled" : (boolean) whether the segment has analytics tracking enabled,
            "tags" : (array) tag names associated with the segment
        },
        ...
    ]
}
WAS THIS PAGE HELPFUL?
New Stuff!