# Get all segments

GET https://app.unleash-instance.example.com/api/admin/segments

Retrieves all segments that exist in this Unleash instance.

Reference: https://docs.getunleash.io/api/get-segments

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get all segments
  version: endpoint_segments.getSegments
paths:
  /api/admin/segments:
    get:
      operationId: get-segments
      summary: Get all segments
      description: Retrieves all segments that exist in this Unleash instance.
      tags:
        - - subpackage_segments
      parameters:
        - name: Authorization
          in: header
          description: Header authentication of the form `undefined <token>`
          required: true
          schema:
            type: string
      responses:
        '200':
          description: segmentsSchema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/segmentsSchema'
components:
  schemas:
    ConstraintSchemaOperator:
      type: string
      enum:
        - value: NOT_IN
        - value: IN
        - value: STR_ENDS_WITH
        - value: STR_STARTS_WITH
        - value: STR_CONTAINS
        - value: NUM_EQ
        - value: NUM_GT
        - value: NUM_GTE
        - value: NUM_LT
        - value: NUM_LTE
        - value: DATE_AFTER
        - value: DATE_BEFORE
        - value: SEMVER_EQ
        - value: SEMVER_GT
        - value: SEMVER_LT
    constraintSchema:
      type: object
      properties:
        contextName:
          type: string
          description: The name of the context field that this constraint should apply to.
        operator:
          $ref: '#/components/schemas/ConstraintSchemaOperator'
          description: >-
            The operator to use when evaluating this constraint. For more
            information about the various operators, refer to [the strategy
            constraint operator
            documentation](https://docs.getunleash.io/concepts/activation-strategies#constraint-operators).
        caseInsensitive:
          type: boolean
          default: false
          description: >-
            Whether the operator should be case sensitive or not. Defaults to
            `false` (being case sensitive).
        inverted:
          type: boolean
          default: false
          description: >-
            Whether the result should be negated or not. If `true`, will turn a
            `true` result into a `false` result and vice versa.
        values:
          type: array
          items:
            type: string
          description: >-
            The context values that should be used for constraint evaluation.
            Use this property instead of `value` for properties that accept
            multiple values.
        value:
          type: string
          description: >-
            The context value that should be used for constraint evaluation. Use
            this property instead of `values` for properties that only accept
            single values.
      required:
        - contextName
        - operator
    adminSegmentSchema:
      type: object
      properties:
        id:
          type: integer
          description: The ID of this segment
        name:
          type: string
          description: The name of this segment
        description:
          type:
            - string
            - 'null'
          description: The description for this segment
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/constraintSchema'
          description: The list of constraints that are used in this segment
        usedInFeatures:
          type:
            - integer
            - 'null'
          description: >-
            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.
        usedInProjects:
          type:
            - integer
            - 'null'
          description: >-
            The number of projects that use this segment. The number includes
            any projects with pending change requests that would add this
            segment.
        project:
          type:
            - string
            - 'null'
          description: >-
            The project the segment belongs to. Only present if the segment is a
            project-specific segment.
        createdBy:
          type:
            - string
            - 'null'
          description: The creator's email or username
        createdAt:
          type: string
          format: date-time
          description: When the segment was created
      required:
        - id
        - name
        - constraints
        - createdAt
    segmentsSchema:
      type: object
      properties:
        segments:
          type: array
          items:
            $ref: '#/components/schemas/adminSegmentSchema'
          description: A list of segments

```

## SDK Code Examples

```python
import requests

url = "https://app.unleash-instance.example.com/api/admin/segments"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/segments';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/api/admin/segments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/api/admin/segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://app.unleash-instance.example.com/api/admin/segments")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.unleash-instance.example.com/api/admin/segments', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/segments");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/segments")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```