API Reference

Get offer by ID

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

Returns detailed information about an offer including title, description, image, location, price, and redemption details.

Path Params
string
required
Query Params
string | null

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

int32 | null

The specific location ID to retrieve offer details for. This is used to show information relevant to a particular merchant location. It is ignored for online-only offers.

double | null

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

double | null

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

double | null

The radius to search for offers around the specified location.

string | null

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

string

The country code for location-based filtering (e.g., "US").

catalog_filter_ids
array of uuids | null

A custom filter ID for program-specific filtering. This ensures additional offers are filtered to the same edition/program.

catalog_filter_ids
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