---
title: "Read segments"
method: GET
path: "/channel/v1/segments"
tags: ["SegmentFolders"]
---

# Read segments

`GET /channel/v1/segments`

## Request

- Base URL: `https://marketplace.appdirect.com/api`
- URL: `https://marketplace.appdirect.com/api/channel/v1/segments`
- Auth: none declared
- TypeScript: <https://skmtc.dev/appdirect/apis/companies/docs/channel/v1/segments/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a paginated list of segments

## Query parameters

- `companyGroupId` string, required
- `number` integer
- `size` integer
- `sort` string
- `searchText` string

## Response `200`

OK

- PagedSegment: Data returned from paged read of segment.
  - `content` Segment[]: Segment details
    - `id` string: Segment ID
    - `name` string: Segment name
    - `code` string: Segment codes are unique codes that you can use for B2B integration by using the API to automatically associate companies with segments. Leave this field blank if a segment code is not required. Note that if you modify the code after you create it, your B2B integration might be affected.
    - `partner` string: Partner name
    - `type` 'MANUAL' | 'DYNAMIC': Segment type
  - `page` PageMeta
    - `number` number: Page number
    - `size` number: Number of results to return
    - `totalElements` number: Total number of elements
    - `totalPages` number: Total number of pages

## Other responses

- `400`: Bad request

## Changes

- **2026-11-06** `1fc240f06971`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/appdirect/apis/companies/changes/channel/v1/segments/get.md)

---

[API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)