Journey Docs
Partner APIFulfillments

Autocomplete Offer Names

Typeahead suggestions for offer names

GET/partner/fulfillments/autocomplete/offers

Overview

Returns offer name suggestions for a search prefix. Designed for typeahead inputs in fulfillment search UIs — call on each keystroke after the first character.

Authentication

Requires a partner API key with the partner:fulfillments:read scope, sent as X-API-Key.

Query Parameters

qquerystringrequired

Search prefix (minimum 1 character)

organizationIdquerystring

External org ID for superadmin keys. Ignored for org-scoped keys.

limitquerynumberdefault: 10

Max suggestions to return (1–20)

Response

suggestionsstring[]required

Array of matching offer name strings

Request

curl "https://api-prd.cf.journey.com/v1/partner/fulfillments/autocomplete/offers?q=spa&limit=5" \
  -H "X-API-Key: jny_xxxx"

Response

200 Response
{
  "suggestions": [
    "Spa Day Pass",
    "Spa Treatment (60 min)",
    "Spa & Pool Access"
  ]
}

On this page