Skip to main content
POST
/
groups
/
search
Get groups
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/groups/search \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "created_at": "<string>",
      "entity_ids": [
        "<string>"
      ],
      "entity_type": "<string>",
      "id": "<string>",
      "lookup_key": "<string>",
      "metadata": {},
      "name": "<string>",
      "status": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Query Parameters

​
entity_type
string

Filter by entity type (e.g., 'price')

​
name
string

Filter by group name (contains search)

​
lookup_key
string

Filter by lookup key (exact match)

​
limit
integer

Number of items to return (default: 20)

​
offset
integer

Number of items to skip (default: 0)

​
sort_by
string

Field to sort by (name, created_at, updated_at)

​
sort_order
string

Sort order (asc, desc)

Response

OK

​
items
object[]
​
pagination
object