API Reference

Get offers

get
https://kigo-core-server-stage.kigodigital.net/api/v1/offers

Returns a filtered, sorted list of offers. Supports location, category, deal type, and personalization filters.

Query Params
string

The language code for the response content (e.g., "EN").

double

The latitude coordinate for location-based filtering and distance calculation.

double

The longitude coordinate for location-based filtering and distance calculation.

double

The radius to search for offers around the specified location.

string

The unit for the search radius (e.g., "MI" or "KM").

sort_by
array of objects

A list of sorting criteria to apply to the offer results. Allows for sorting by fields like distance, highest_savings, etc.

sort_by
filter
object

A set of filters to apply to the offer search, refining results based on various criteria.

int32
≥ 0

The maximum number of offers to return in a single response. For example, limit=10 will return at most 10 offers.

int32
≥ 0

The number of offers to skip before starting to return results, used for pagination. For example, offset=10 with limit=10 will return offers 11 through 20.

Responses

Updated 2 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago