---
title: "Query groups"
method: POST
path: "/groups/search"
tags: ["Groups"]
---

# Query groups

`POST /groups/search`

Use when listing or searching groups (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.

## Request body

- TypesGroupFilter
  - `end_time` string, date-time
  - `entity_type` string
  - `expand` string
  - `filters` TypesFilterCondition[] — filters allows complex filtering based on multiple fields
    - `data_type` 'string' | 'number' | 'date' | 'array'
    - `field` string
    - `operator` 'eq' | 'contains' | 'not_contains' | 'gt' | 'lt' | 'gte' | 'in' | 'not_in' | 'before' | 'after'
    - `value` TypesValue
      - `array` string[]
      - `boolean` boolean
      - `date` string
      - `number` number
      - `string` string
  - `group_ids` string[] — Group specific filters
  - `limit` integer
  - `lookup_key` string
  - `name` string
  - `offset` integer
  - `order` 'asc' | 'desc'
  - `sort` TypesSortCondition[]
    - `direction` 'asc' | 'desc'
    - `field` string
  - `start_time` string, date-time
  - `status` 'published' | 'deleted' | 'archived'

## Response `200`

OK

- ListGroupsResponse
  - `items` GroupResponse[]
    - `created_at` string, date-time
    - `entity_ids` string[]
    - `entity_type` string
    - `id` string
    - `lookup_key` string
    - `metadata` object
    - `name` string
    - `status` string
    - `updated_at` string, date-time
  - `pagination` TypesPaginationResponse
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `400` — Invalid request
- `500` — Server error

## Changes

> 108 revisions in range; 51 could not be searched.

- **2026-07-09** `7d57386313c7` — 2 breaking, 16 info
  - the request's body type/format changed from ``/`` to `object`/``
  - the `pagination` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the new optional request property `end_time`
  - added the new optional request property `entity_type`
  - …14 more
- **2026-07-09** `4b1a811c4179` — 4 breaking, 16 warning
  - the request's body type/format changed from `object`/`` to ``/``
  - the `items/items/created_at` response's property type/format changed from `string`/`date-time` to `string`/`` for status `200`
  - the `items/items/updated_at` response's property type/format changed from `string`/`date-time` to `string`/`` for status `200`
  - the `pagination` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - …16 more

[Change history](https://skmtc.dev/flexprice/apis/flexprice-api/changes/groups/search/post.md)

---

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