Segment Details Endpoint

get

/segments/details

This endpoint allows you to retrieve relevant information on the segment, which can be identified by the segment_id.

Request Parameters

Parameter Required Data Type Description
segment_id Required String See Segment API identifier.

The segment_id for a given segment can be found in your Developer Console within your Braze account or you can use the Segment List Endpoint.

Example Request

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/segments/details?segment_id={{segment_identifier}}' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Response

1
2
3
4
5
6
7
8
9
10
11
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
      "message": (required, string) the status of the export, returns 'success' when completed without errors,
      "created_at" : (string) date created as ISO 8601 date,
      "updated_at" : (string) date last updated as ISO 8601 date,
      "name" : (string) segment name,
      "description" : (string) human-readable description of filters,
      "text_description" : (string) segment description, 
      "tags" : (array) tag names associated with the segment
}
WAS THIS PAGE HELPFUL?
New Stuff!