Group redemptions - Omneo API

Website

Overview

Authentication

Profiles

Commerce

Incentives

Lists

Groups

Ratings and Interactions

Reactions

Organisations and access

Configuration

Platform

Questionnaires

Filtering

This endpoint accepts filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.

Examples

curl -X GET "https://api.[tenant].getomneo.com/api/v3/redemptions/group/{attribute}?filter[external_id]={external_id}" \
  -H "Authorization: Bearer ${TOKEN}"

curl -X GET "https://api.[tenant].getomneo.com/api/v3/redemptions/group/{attribute}?filter[created_at][gte]=2026-01-01&filter[created_at][lt]=2026-02-01" \
  -H "Authorization: Bearer ${TOKEN}"

Operators

Operator	Meaning	Example
`eq`	Equal to. Applied when you give no operator.	`filter[external_id]={external_id}`
`ne`	Not equal to.	`filter[external_id][ne]={external_id}`
`gt`	Greater than.	`filter[created_at][gt]=2026-01-01`
`gte`	Greater than or equal to.	`filter[created_at][gte]=2026-01-01`
`lt`	Less than.	`filter[created_at][lt]=2026-02-01`
`lte`	Less than or equal to.	`filter[created_at][lte]=2026-02-01`
`in`	Matches any value in a comma separated list.	`filter[id][in]=123,456`
`not_in`	Excludes every value in a comma separated list.	`filter[id][not_in]=123,456`
`nullable`	`1` returns records where the attribute is empty. Any other value returns records where it is set.	`filter[redeem_at][nullable]=1`

The not_has operator applies to related attributes, which this endpoint does not have.

Filter attributes

Attribute	Attribute	Attribute
`id`	`type`	`location_id`
`meta`	`external_id`	`exchange_rate`
`redeem_at`	`has_benefit`	`has_reward`
`has_point`	`has_credit`	`transaction_external_id`
`transaction_receipt_ref`	`profile_id`	`created_at`
`updated_at`	`linked_source_id`	`linked_source_type`

Each attribute above is also a valid sort key, for example ?sort=-created_at for descending order.