propfirms

Public: search promotional offers across visible firms. Defaults to live (active, unexpired) offers. Pass propfirmId for one firm's offers, or challengeId for offers that apply to a challenge (firm-wide offers included).

get/api/propfirms/offers/query

Request

Query parameters

offerIdstring

Comma-separated public offer ids.

promoCodestring

Case-insensitive substring of the promo code.

offerTextstring

Case-insensitive search over promo code and offer descriptions.

isActive'true' | 'false'

Defaults to live offers only. Pass false to look at inactive offers.

isFeatured'true' | 'false'

Boolean filter as "true" or "false".

discountIsPercent'true' | 'false'

Boolean filter as "true" or "false".

discountMinstring

Minimum discount value (percent or absolute, matching discountIsPercent).

discountMaxstring

Maximum discount value.

includeInactive'true' | 'false'

When true, inactive offers are not hidden. Defaults to false.

includeExpired'true' | 'false'

When true, ended offers are not hidden. Defaults to false.

pageIndexstring

0-based page index. Defaults to 0.

pageQuantitystring

Page size. Defaults to 50, capped at 100.

direction'asc' | 'desc'

Sort direction. Defaults per sort key.

textstring

Case-insensitive search over promo code, descriptions, and firm name/slug.

firmIdstring

Comma-separated internal firm ids.

propfirmIdstring

Comma-separated public firm slugs.

challengeIdstring

Comma-separated challenge ids. An offer matches when it applies to at least one (all-challenges offers match that firm's challenges).

sort'discountValue' | 'endsAt' | 'promoCode'

Defaults to featured first, then discount.

Response

Success. The payload is wrapped in the standard { data, errors } envelope.

errorsunknown

Changes

No recorded changes to this operation across all 7 revisions of this API.