Segments

Get all segments

Changed on

Retrieves all segments that exist in this Unleash instance.

get/api/admin/segments

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/segments
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Response

segmentsSchema

Example response

{
  "segments": [
    {
      "id": 2,
      "name": "ios-users",
      "description": "IOS users segment",
      "constraints": [
        {
          "contextName": "appName",
          "operator": "IN",
          "values": [
            "my-app",
            "my-other-app"
          ],
          "value": "my-app"
        }
      ],
      "usedInFeatures": 3,
      "usedInProjects": 2,
      "project": "red-vista",
      "createdBy": "someone@example.com",
      "createdAt": "2023-04-12T11:13:31.960Z"
    }
  ]
}

Changes

  • b2c3116e633eRevision changes
    • warning

      added the new SEMVER_GTE enum value to the //// response property for the response status

    • warning

      added the new SEMVER_LTE enum value to the //// response property for the response status

  • 774670258f04Revision changes
    • warning

      added the new REGEX enum value to the //// response property for the response status