---
title: "Get a list of Market Segmentation Segments."
method: GET
path: "/market-segmentation/v1/segments/{enabled}"
tags: ["Market Segmentation"]
---

# Get a list of Market Segmentation Segments.

`GET /market-segmentation/v1/segments/{enabled}`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/market-segmentation/v1/segments/{enabled}`
- Auth: OAuth 2
  - Authorization code: `https://api.cloudbeds.com/auth/oauth/authorize`
  - Token URL: `https://api.cloudbeds.com/auth/oauth/token` scopes: `read:marketsegment`

## Path parameters

- `enabled` boolean, required

## Query parameters

- `offset` integer
- `limit` integer
- `filters` QueryParameterDynamicFilterSchema
  - `filters` DynamicFilterSchema: Represents a logical group of filters with keys like 'and' or 'or'
    - `and` union[]: Logical operator grouping filters or nested logical groups
      - union
        - DynamicFilterFieldSchema: Represents a single filter condition
          - `field` string: The field to apply the filter on
          - `operator` 'greater_than_or_equal' | 'greater_than' | 'less_than_or_equal' | 'less_than' | 'equal' | 'in' | 'not_in' | 'is_null' | 'is_not_null' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'not_starts_with' | 'ends_with' | 'not_ends_with' | 'is_empty' | 'is_not_empty': The operator to use for the filter
          - `value` union: The value for the filter
            - string
            - string, date-time
            - string, date
            - integer
            - boolean
            - string[]
            - integer[]
            - string[]
            - string[]
        - DynamicFilterSchema (recursive)
    - `or` union[]: Logical operator grouping filters or nested logical groups
      - union
        - DynamicFilterFieldSchema: Represents a single filter condition
          - `field` string: The field to apply the filter on
          - `operator` 'greater_than_or_equal' | 'greater_than' | 'less_than_or_equal' | 'less_than' | 'equal' | 'in' | 'not_in' | 'is_null' | 'is_not_null' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'not_starts_with' | 'ends_with' | 'not_ends_with' | 'is_empty' | 'is_not_empty': The operator to use for the filter
          - `value` union: The value for the filter
            - string
            - string, date-time
            - string, date
            - integer
            - boolean
            - string[]
            - integer[]
            - string[]
            - string[]
        - DynamicFilterSchema (recursive)

## Headers

- `x-property-id` string, required

## Response `200`

List of Market Segmentation Segments.

- SegmentListResponseSchema
  - `limit` integer
  - `offset` integer
  - `data` SegmentResponseSchema[], nullable
    - `id` string
    - `groupId` string
    - `name` string
    - `code` string
    - `description` string
    - `isEnabled` boolean
    - `isDefault` boolean
    - `ratePlanIds` string[]
    - `createdAt` string, Y-m-d\TH:i:sP
    - `updatedAt` string, Y-m-d\TH:i:sP, nullable
    - `canEdit` string[]
    - `canDelete` boolean
    - `canDisable` boolean

## Other responses

- `400`: Bad request response.
- `403`: Forbidden response.
- `500`: Internal server error.

---

[API](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2.md) - [All operations](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/revisions/69bffac143cc?raw)