---
title: "Query segments"
method: POST
path: "/segments/query"
tags: ["product:chat"]
---

# Query segments

`POST /segments/query`

Query segments

## Request body

- QuerySegmentsRequest, nullable
  - `filter` object, required — Filter to apply to the query
  - `limit` integer
  - `next` string
  - `prev` string
  - `sort` SortParamRequest[] — Array of sort parameters
    - `direction` integer — Direction of sorting, 1 for Ascending, -1 for Descending, default is 1. One of: -1, 1
    - `field` string — Name of field to sort by
    - `type` string — Type of field to sort by. Empty string or omitted means string type (default). One of: number, boolean

## Response `201`

Successful response

- QuerySegmentsResponse, nullable
  - `duration` string, required — Duration of the request in milliseconds
  - `next` string
  - `prev` string
  - `segments` SegmentResponse[], required — Segments
    - `all_sender_channels` boolean, required
    - `all_users` boolean, required
    - `created_at` string, date-time, required
    - `deleted_at` string, date-time, required
    - `description` string, required
    - `filter` object, required
    - `id` string, required
    - `name` string, required
    - `size` integer, required
    - `type` string, required
    - `updated_at` string, date-time, required

## Other responses

- `400` — Bad request
- `429` — Too many requests

---

[API](https://skmtc.net/getstream/apis/stream-api.md) · [All operations](https://skmtc.net/getstream/apis/stream-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getstream/stream-api/versions/3dba86aaa0d8/schema)