Get a segment | Unleash Documentation

Retrieves a segment based on its ID.

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

idintegerRequired

a segment id

adminSegmentSchema

idinteger>=0

The ID of this segment

namestring

The name of this segment

constraintslist of objects

The list of constraints that are used in this segment

createdAtstringformat: "date-time"

When the segment was created

descriptionstring or null

The description for this segment

usedInFeaturesinteger or null>=0

The number of feature flags that use this segment. The number also includes the any flags with pending change requests that would add this segment.

usedInProjectsinteger or null>=0

The number of projects that use this segment. The number includes any projects with pending change requests that would add this segment.

projectstring or null

The project the segment belongs to. Only present if the segment is a project-specific segment.

createdBystring or null

The creator's email or username

1	{
2	"id": 2,
3	"name": "ios-users",
4	"constraints": [
5	{
6	"contextName": "appName",
7	"operator": "IN",
8	"caseInsensitive": false,
9	"inverted": false,
10	"values": [
11	"my-app",
12	"my-other-app"
13	],
14	"value": "my-app"
15	}
16	],
17	"createdAt": "2023-04-12T11:13:31.960Z",
18	"description": "IOS users segment",
19	"usedInFeatures": 3,
20	"usedInProjects": 2,
21	"project": "red-vista",
22	"createdBy": "someone@example.com"
23	}

1	curl https://app.unleash-instance.example.com/api/admin/segments/1 \
2	-H "Authorization: <apiKey>"