---
title: "List Segment Configs"
method: GET
path: "/data-quality/v1/segment/configs"
tags: ["Segment"]
---

# List Segment Configs

`GET /data-quality/v1/segment/configs`

## Request

- Base URL: `https://api.zoominfo.com/gtm`
- URL: `https://api.zoominfo.com/gtm/data-quality/v1/segment/configs`
- Auth: OAuth 2
  - Authorization code: `https://login.zoominfo.com`
  - Token URL: `https://okta-login.zoominfo.com/oauth2/default/v1/token` scopes: `api:data-quality:read`

Returns a paginated list of segment configurations.

This is how you discover a `configId` before passing it to Run Segmentation, and how you
check which segment definitions already exist before creating a duplicate.

Each item carries the full config definition, including its `segments` and their `rules`,
plus `createdAt` and `updatedAt` under `meta`.

Filter by `filter[name]` (case-insensitive contains match on `name`). Order with `sort` —
allowed fields: `name`, `createdAt`, `updatedAt`. Prefix the field with `-` for descending
order. Use `page[number]` (1-based) and `page[size]` (default `25`, max `200`) to paginate.

Returns `200` with a paginated array of segment config resources and JSON:API pagination
links. Returns `400` if filter, sort, or pagination parameters are invalid.

This endpoint does not consume credits.

## Query parameters

- `filter[name]` string
- `page[number]` integer
- `page[size]` integer
- `sort` string

## Response `200`

Success

- SegmentConfigListJsonApiModel: JSON API model for a paginated list of segment configs.
  - `data` SegmentConfig[], required: The primary data of the document
    - `id` string, required: The unique identifier for the resource
    - `type` string, required: The type of the resource
    - `attributes` SegmentConfigAttributes, required: Full attributes of a segment configuration.
      - `name` string, required: Display name for the segment config.
      - `action` 'FIND_FIRST' | 'FIND_LAST' | 'FIND_ALL' | 'ADD_ALL', required: How multiple segments match the same record.
      - `mergeOperator` string: Delimiter used to join matched output values when `action` is `FIND_ALL`. Common values: `,` (default), `, `, `;`, `|`, `-`, newline, or tab. Any short string is accepted, so this is a free-form delimiter rather than a fixed enum.
      - `segments` Segment[], required: Ordered list of segments defined in this config.
        - `label` string, required: Display label for this segment.
        - `outputValue` string, required: Value written to the output field on the record when this segment matches.
        - `order` integer, required: Server-assigned priority order of this segment within the config (0-based, lower = higher priority).
        - `rules` SegmentRule[], required: Ordered list of rules that must be satisfied for this segment to match.
          - `operator` 'TEXT_EQUALS' | 'TEXT_NOT_EQUALS' | 'TEXT_CONTAINS' | 'TEXT_CONTAINS_WORD' | 'TEXT_NOT_CONTAINS' | 'TEXT_NOT_CONTAINS_WORD' | 'TEXT_STARTS' | 'TEXT_NOT_STARTS' | 'TEXT_ENDS' | 'TEXT_NOT_ENDS' | 'NUM_EQUALS' | 'NUM_MORE' | 'NUM_LESS' | 'NUM_BETWEEN' | 'NUM_GREATER_OR_EQUALS' | 'NUM_LESS_OR_EQUALS' | 'BOOL_TRUE' | 'BOOL_FALSE' | 'IS_NULL' | 'IS_NOT_NULL' | 'DIVIDER', required: Comparison operator for a segment rule.
          - `field` string: Field name to evaluate. Absent for divider operators that separate rule groups.
          - `value` string[]: Values to compare the field against. Treated as an OR-list for most operators.
      - `fieldsUsedInRules` string[], required: Distinct field names referenced by this config's segment rules, sorted alphabetically. Divider rules contribute no field. Read-only; derived from `segments[].rules[].field`.
    - `meta` SegmentConfigMeta: Non-standard metadata for a segment config.
      - `createdAt` string, date-time, required: ISO 8601 timestamp at which this segment config was created.
      - `updatedAt` string, date-time, required: ISO 8601 timestamp at which this segment config was last updated.
  - `meta` SegmentConfigListMeta: Page metadata wrapper for paginated segment config list responses.
    - `page` SegmentConfigPageMeta, required: Per-page metadata for paginated segment config list responses.
      - `number` integer, required: Current page number (1-based).
      - `size` integer, required: Number of items in the current page.
      - `totalPages` integer, required: Total number of pages available.
      - `totalItems` integer, required: Total number of items across all pages.
  - `links` SegmentConfigListLinks: Paging links for segment config list responses.
    - `self` string, uri: The link that generated the current response document
    - `first` string, uri: A link to the first page of data
    - `last` string, uri: A link to the last page of data
    - `prev` string, uri: A link to the previous page of data
    - `next` string, uri: A link to the next page of data

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests

---

[API](https://skmtc.dev/zoominfo/apis/data-quality-api-v1.md) - [All operations](https://skmtc.dev/zoominfo/apis/data-quality-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/zoominfo/apis/data-quality-api-v1/revisions/7229ed1f3b09?raw)