---
title: "GET /api/admin/segments/"
method: GET
path: "/api/admin/segments/"
tags: ["Segments"]
---

# GET /api/admin/segments/

`GET /api/admin/segments/`

Get all segments.

## Query parameters

- `workspaceId` string, required
- `ids` string[]
- `resourceType` union
  - 'Declarative'
  - 'Internal'

## Response `200`

Default Response

- object
  - `segments` object[], required
    - `id` string, required
    - `workspaceId` string, required
    - `name` string, required
    - `definition` object, required
      - `entryNode` union, required
        - object
          - `type` 'Trait', required
          - `id` string, required
          - `path` string, required
          - `operator` union, required
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - object
          - `type` 'And', required
          - `id` string, required
          - `children` string[], required
        - object
          - `type` 'Or', required
          - `id` string, required
          - `children` string[], required
        - object
          - `type` 'Performed', required
          - `id` string, required
          - `event` string, required
          - `times` number
          - `timesOperator` union
            - '='
            - '>='
            - '<'
          - `timeOperator` union
            - 'Within'
            - 'AfterAbsolute'
            - 'BeforeAbsolute'
          - `withinSeconds` number
          - `absoluteTimestamp` string
          - `properties` object[]
            - `path` string, required
            - `operator` union, required
              - …
        - object
          - `type` 'LastPerformed', required
          - `id` string, required
          - `event` string, required
          - `whereProperties` object[] — Used to select which events are eligible to be considered.
            - `path` string, required
            - `operator` union, required
              - …
          - `hasProperties` object[] — Used to evaluate whether the user is in the segment based on the properties of the selected event.
            - `path` string, required
            - `operator` union, required
              - …
        - object
          - `type` 'Email', required
          - `id` string, required
          - `event` union, required
            - 'DFInternalMessageSent'
            - 'DFEmailDropped'
            - 'DFEmailDelivered'
            - 'DFEmailOpened'
            - 'DFEmailClicked'
            - 'DFEmailBounced'
            - 'DFEmailMarkedSpam'
          - `times` number
          - `templateId` string, required
        - object
          - `type` 'Broadcast', required
          - `id` string, required
        - object
          - `type` 'SubscriptionGroup', required
          - `id` string, required
          - `subscriptionGroupId` string, required
          - `subscriptionGroupType` union, required
            - 'OptIn'
            - 'OptOut'
        - object
          - `type` 'RandomBucket', required
          - `id` string, required
          - `percent` number, required — The percentage of users to be randomly assigned to be in the segment. Expressed as a number between 0 and 1.
        - object
          - `type` 'Includes', required
          - `id` string, required
          - `path` string, required
          - `item` string, required
        - object
          - `type` 'Manual', required
          - `version` number, required
          - `id` string, required
        - object
          - `type` 'Everyone', required
          - `id` string, required
        - object
          - `type` 'KeyedPerformed', required
          - `id` string, required
          - `event` string, required
          - `key` string, required
          - `times` number
          - `timesOperator` union
            - '='
            - '>='
            - '<'
          - `properties` object[]
            - `path` string, required
            - `operator` union, required
              - …
      - `nodes` union[], required
        - union
          - object
            - `type` 'Trait', required
            - `id` string, required
            - `path` string, required
            - `operator` union, required
              - …
          - object
            - `type` 'And', required
            - `id` string, required
            - `children` string[], required
          - object
            - `type` 'Or', required
            - `id` string, required
            - `children` string[], required
          - object
            - `type` 'Performed', required
            - `id` string, required
            - `event` string, required
            - `times` number
            - `timesOperator` union
              - …
            - `timeOperator` union
              - …
            - `withinSeconds` number
            - `absoluteTimestamp` string
            - `properties` object[]
              - …
          - object
            - `type` 'LastPerformed', required
            - `id` string, required
            - `event` string, required
            - `whereProperties` object[] — Used to select which events are eligible to be considered.
              - …
            - `hasProperties` object[] — Used to evaluate whether the user is in the segment based on the properties of the selected event.
              - …
          - object
            - `type` 'Email', required
            - `id` string, required
            - `event` union, required
              - …
            - `times` number
            - `templateId` string, required
          - object
            - `type` 'Broadcast', required
            - `id` string, required
          - object
            - `type` 'SubscriptionGroup', required
            - `id` string, required
            - `subscriptionGroupId` string, required
            - `subscriptionGroupType` union, required
              - …
          - object
            - `type` 'RandomBucket', required
            - `id` string, required
            - `percent` number, required — The percentage of users to be randomly assigned to be in the segment. Expressed as a number between 0 and 1.
          - object
            - `type` 'Includes', required
            - `id` string, required
            - `path` string, required
            - `item` string, required
    - `subscriptionGroupId` string
    - `updatedAt` number, required
    - `lastRecomputed` number
    - `resourceType` union
      - 'Declarative'
      - 'Internal'
    - `status` union
      - 'NotStarted'
      - 'Running'
      - 'Paused'
    - `createdAt` number, required
    - `definitionUpdatedAt` number, required

---

[API](https://skmtc.net/dittofeed/apis/dittofeed-api.md) · [All operations](https://skmtc.net/dittofeed/apis/dittofeed-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dittofeed/dittofeed-api/versions/13cf71747bf1/schema)