curl --request POST \
--url https://us.api.flexprice.io/v1/groups/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_time": "<string>",
"entity_type": "<string>",
"expand": "<string>",
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"group_ids": [
"<string>"
],
"limit": 500,
"lookup_key": "<string>",
"name": "<string>",
"offset": 1,
"order": "asc",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"start_time": "<string>",
"status": "published"
}
'{
"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
}
}Use when listing or searching groups (e.g. admin catalog). Returns a paginated list; supports filtering and sorting.
curl --request POST \
--url https://us.api.flexprice.io/v1/groups/search \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_time": "<string>",
"entity_type": "<string>",
"expand": "<string>",
"filters": [
{
"data_type": "string",
"field": "<string>",
"operator": "eq",
"value": {
"array": [
"<string>"
],
"boolean": true,
"date": "<string>",
"number": 123,
"string": "<string>"
}
}
],
"group_ids": [
"<string>"
],
"limit": 500,
"lookup_key": "<string>",
"name": "<string>",
"offset": 1,
"order": "asc",
"sort": [
{
"direction": "asc",
"field": "<string>"
}
],
"start_time": "<string>",
"status": "published"
}
'{
"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
}
}Enter your API key in the format x-api-key <api-key>*
Filter
filters allows complex filtering based on multiple fields
Show child attributes
Group specific filters
1 <= x <= 1000x >= 0asc, desc Show child attributes
published, deleted, archived