List Segments in Environment

Retrieves the segments given an environment.

Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_SEGMENT_VIEWER
  • API_SEGMENT_EDITOR

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE
  • ENVIRONMENT

To learn more about Admin API Key roles and scopes, see API keys overview.


JSON Received

{
    "objects": [ SEGMENT_IN_ENVIRONMENT ], // Array of Segments returned
    "offset": Number, // Offset received
    "limit": Number, // Limit received
    "totalCount": Number // Total number of Segments for the environment
}
Language