---
title: "Returns a list of all market segments, filtered by the specified parameters."
method: GET
path: "/settings/v1/market-segments"
tags: ["MarketSegment"]
---

# Returns a list of all market segments, filtered by the specified parameters.

`GET /settings/v1/market-segments`

<br>You must have at least one of these scopes: 'setup.read, setup.manage'.

## Query parameters

- `propertyIds` string[]
- `pageNumber` integer
- `pageSize` integer

## Response `200`

Return market segments.

- MarketSegmentListModel
  - `marketSegments` MarketSegmentModel[], required — List of market segments
    - `id` string, required — The id of the market segment
    - `code` string, required — The code of the market segment
    - `name` string, required — The name of the market segment
    - `description` string, nullable — The description of the market segment
    - `propertyIds` string[], nullable — The list of property ids this market segment belongs to
  - `count` integer, required — Total count of items

## Other responses

- `204` — No market segments could be found.
- `400` — Bad request.
- `401` — You are unauthorized.
- `403` — Forbidden.
- `404` — The Request-URI could not be found.
- `422` — Validation errors in the request body or query params.
- `499` — Client closed request.
- `500` — An unexpected error occurred.
- `503` — The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-settings-api.md) · [All operations](https://skmtc.dev/apaleo/apis/apaleo-settings-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apaleo/apaleo-settings-api/revisions/da1c3b71ee9a/schema)