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

# Read dynamic segments

`GET /channel/v1/segments/dynamicSegments`

## Request

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

Reads a dynamic segment

## Query parameters

- `dynamicSegmentId` string, required

## Response `200`

OK

- DynamicSegment: Dynamic segments contain users selected automatically based on filter values, as opposed to manual segments, in which Marketplace Managers select companies manually.
  - `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` string: Segment type
  - `filters` Filters[]: Dynamic filter
    - Filter[]: Filters
      - `operator` string, required: Filter operator
      - `conditions` FilterExpression[], required
        - `parameter` string, required: Filter parameter field
        - `operator` string, required: Filter operator
        - `values` string[], required: Values for the parameter field

## 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/dynamicSegments/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)